Package com.oracle.bmc.datasafe.model

Class DiscoveryJob

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class DiscoveryJob
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A data discovery job.

    It helps track job’s metadata as well as result statistics.
    Note: Objects should always be created or deserialized using the DiscoveryJob.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 DiscoveryJob.Builder, which maintain a set of all explicitly set fields called DiscoveryJob.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).

    • Constructor Detail

      • DiscoveryJob

        @Deprecated
@ConstructorProperties({"id","discoveryType","displayName","compartmentId","timeStarted","timeFinished","lifecycleState","sensitiveDataModelId","targetId","schemasForDiscovery","tablesForDiscovery","sensitiveTypeIdsForDiscovery","sensitiveTypeGroupIdsForDiscovery","isSampleDataCollectionEnabled","isAppDefinedRelationDiscoveryEnabled","isIncludeAllSchemas","isIncludeAllSensitiveTypes","totalSchemasScanned","totalObjectsScanned","totalColumnsScanned","totalNewSensitiveColumns","totalModifiedSensitiveColumns","totalDeletedSensitiveColumns","freeformTags","definedTags","systemTags"})
public DiscoveryJob​(String id,
                    DiscoveryJob.DiscoveryType discoveryType,
                    String displayName,
                    String compartmentId,
                    Date timeStarted,
                    Date timeFinished,
                    DiscoveryLifecycleState lifecycleState,
                    String sensitiveDataModelId,
                    String targetId,
                    List<String> schemasForDiscovery,
                    List<TablesForDiscovery> tablesForDiscovery,
                    List<String> sensitiveTypeIdsForDiscovery,
                    List<String> sensitiveTypeGroupIdsForDiscovery,
                    Boolean isSampleDataCollectionEnabled,
                    Boolean isAppDefinedRelationDiscoveryEnabled,
                    Boolean isIncludeAllSchemas,
                    Boolean isIncludeAllSensitiveTypes,
                    Long totalSchemasScanned,
                    Long totalObjectsScanned,
                    Long totalColumnsScanned,
                    Long totalNewSensitiveColumns,
                    Long totalModifiedSensitiveColumns,
                    Long totalDeletedSensitiveColumns,
                    Map<String,​String> freeformTags,
                    Map<String,​Map<String,​Object>> definedTags,
                    Map<String,​Map<String,​Object>> systemTags)
        Deprecated.

    • Method Detail

      • getId

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

      • getDiscoveryType

        public DiscoveryJob.DiscoveryType getDiscoveryType()
        The type of the discovery job.

        It defines the job’s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        The display name of the discovery job.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the discovery job.
        Returns:
        the value

      • getTimeStarted

        public Date getTimeStarted()
        The date and time the discovery job started, in the format defined by RFC3339.
        Returns:
        the value

      • getTimeFinished

        public Date getTimeFinished()
        The date and time the discovery job finished, in the format defined by RFC3339..
        Returns:
        the value

      • getLifecycleState

        public DiscoveryLifecycleState getLifecycleState()
        The current state of the discovery job.
        Returns:
        the value

      • getSensitiveDataModelId

        public String getSensitiveDataModelId()
        The OCID of the sensitive data model associated with the discovery job.
        Returns:
        the value

      • getTargetId

        public String getTargetId()
        The OCID of the target database associated with the discovery job.
        Returns:
        the value

      • getSchemasForDiscovery

        public List<String> getSchemasForDiscovery()
        The schemas used for data discovery.
        Returns:
        the value

      • getTablesForDiscovery

        public List<TablesForDiscovery> getTablesForDiscovery()
        The data discovery jobs will scan the tables specified here, including both schemas and tables.
        Returns:
        the value

      • getSensitiveTypeIdsForDiscovery

        public List<String> getSensitiveTypeIdsForDiscovery()
        The OCIDs of the sensitive types used for data discovery.
        Returns:
        the value

      • getSensitiveTypeGroupIdsForDiscovery

        public List<String> getSensitiveTypeGroupIdsForDiscovery()
        The OCIDs of the sensitive type groups to be used by data discovery jobs.
        Returns:
        the value

      • getIsSampleDataCollectionEnabled

        public Boolean getIsSampleDataCollectionEnabled()
        Indicates if the discovery job should collect and store sample data values for the discovered columns.

        Sample data helps review the discovered columns and ensure that they actually contain sensitive data. As it collects original data from the target database, it’s disabled by default and should be used only if it’s acceptable to store sample data in Data Safe’s repository in Oracle Cloud. Note that sample data values are not collected for columns with the following data types: LONG, LOB, RAW, XMLTYPE and BFILE.

        Returns:
        the value

      • getIsAppDefinedRelationDiscoveryEnabled

        public Boolean getIsAppDefinedRelationDiscoveryEnabled()
        Indicates if the discovery job should identify potential application-level (non-dictionary) referential relationships between columns.

        Note that data discovery automatically identifies and adds database-level (dictionary-defined) relationships. This option helps identify application-level relationships that are not defined in the database dictionary, which in turn, helps identify additional sensitive columns and preserve referential integrity during data masking. It’s disabled by default and should be used only if there is a need to identify application-level relationships.

        Returns:
        the value

      • getIsIncludeAllSchemas

        public Boolean getIsIncludeAllSchemas()
        Indicates if all the schemas in the associated target database are used for data discovery.

        If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle).

        Returns:
        the value

      • getIsIncludeAllSensitiveTypes

        public Boolean getIsIncludeAllSensitiveTypes()
        Indicates if all the existing sensitive types are used for data discovery.

        If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

        Returns:
        the value

      • getTotalSchemasScanned

        public Long getTotalSchemasScanned()
        The total number of schemas scanned by the discovery job.
        Returns:
        the value

      • getTotalObjectsScanned

        public Long getTotalObjectsScanned()
        The total number of objects (tables and editioning views) scanned by the discovery job.
        Returns:
        the value

      • getTotalColumnsScanned

        public Long getTotalColumnsScanned()
        The total number of columns scanned by the discovery job.
        Returns:
        the value

      • getTotalNewSensitiveColumns

        public Long getTotalNewSensitiveColumns()
        The total number of new sensitive columns identified by the discovery job.
        Returns:
        the value

      • getTotalModifiedSensitiveColumns

        public Long getTotalModifiedSensitiveColumns()
        The total number of modified sensitive columns identified by the discovery job.
        Returns:
        the value

      • getTotalDeletedSensitiveColumns

        public Long getTotalDeletedSensitiveColumns()
        The total number of deleted sensitive columns identified by the discovery job.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Free-form tags for this resource.

        Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

        Example: {"Department": "Finance"}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

        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