Package com.oracle.bmc.datasafe.model

Class DiscoveryJobResult

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class DiscoveryJobResult
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A discovery job result representing a sensitive column.

    It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.
    Note: Objects should always be created or deserialized using the DiscoveryJobResult.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the DiscoveryJobResult.Builder, which maintain a set of all explicitly set fields called DiscoveryJobResult.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getKey

        public String getKey()
        The unique key that identifies the discovery result.
        Returns:
        the value

      • getDiscoveryType

        public DiscoveryJobResult.DiscoveryType getDiscoveryType()
        The type of the discovery result.

        It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

        Returns:
        the value

      • getSensitiveColumnkey

        public String getSensitiveColumnkey()
        The unique key that identifies the sensitive column represented by the discovery result.
        Returns:
        the value

      • getAppName

        public String getAppName()
        The name of the application.

        An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

        Returns:
        the value

      • getSchemaName

        public String getSchemaName()
        The database schema that contains the sensitive column.
        Returns:
        the value

      • getObjectName

        public String getObjectName()
        The database object that contains the sensitive column.
        Returns:
        the value

      • getColumnName

        public String getColumnName()
        The name of the sensitive column.
        Returns:
        the value

      • getObjectType

        public DiscoveryJobResult.ObjectType getObjectType()
        The type of the database object that contains the sensitive column.
        Returns:
        the value

      • getDataType

        public String getDataType()
        The data type of the sensitive column.
        Returns:
        the value

      • getSensitiveTypeId

        public String getSensitiveTypeId()
        The OCID of the sensitive type associated with the sensitive column.
        Returns:
        the value

      • getParentColumnKeys

        public List<String> getParentColumnKeys()
        Unique keys identifying the columns that are parents of the sensitive column.

        At present, it tracks a single parent only.

        Returns:
        the value

      • getRelationType

        public DiscoveryJobResult.RelationType getRelationType()
        The type of referential relationship the sensitive column has with its parent.

        NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

        Returns:
        the value

      • getEstimatedDataValueCount

        public Long getEstimatedDataValueCount()
        The estimated number of data values the column has in the associated database.
        Returns:
        the value

      • getSampleDataValues

        public List<String> getSampleDataValues()
        Original data values collected for the sensitive column from the associated database.

        Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

        Returns:
        the value

      • getAppDefinedChildColumnKeys

        public List<String> getAppDefinedChildColumnKeys()
        Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.
        Returns:
        the value

      • getDbDefinedChildColumnKeys

        public List<String> getDbDefinedChildColumnKeys()
        Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.
        Returns:
        the value

      • getPlannedAction

        public DiscoveryJobResult.PlannedAction getPlannedAction()
        Specifies how to process the discovery result.

        It’s set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn’t change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren’t reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

        Returns:
        the value

      • getIsResultApplied

        public Boolean getIsResultApplied()
        Indicates whether the discovery result has been processed.

        You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

        Returns:
        the value

      • getDiscoveryJobId

        public String getDiscoveryJobId()
        The OCID of the discovery job.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel