Package com.oracle.bmc.datasafe.model

Class CreateDiscoveryJobDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CreateDiscoveryJobDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details to create a new data discovery job.
    Note: Objects should always be created or deserialized using the CreateDiscoveryJobDetails.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 CreateDiscoveryJobDetails.Builder, which maintain a set of all explicitly set fields called CreateDiscoveryJobDetails.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

    • Method Detail

      • 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

      • getSensitiveDataModelId

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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where the discovery job resource should be created.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly name for the discovery job.

        Does not have to be unique, and it is changeable. Avoid entering confidential information.

        Returns:
        the value

      • getSchemasForDiscovery

        public List<String> getSchemasForDiscovery()
        The schemas to be scanned by the discovery job.

        If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

        Returns:
        the value

      • getTablesForDiscovery

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

        In the absence of explicit input, the list of tables is obtained from the tablesForDiscovery attribute of the sensitive data model.

        Returns:
        the value

      • getSensitiveTypeIdsForDiscovery

        public List<String> getSensitiveTypeIdsForDiscovery()
        The OCIDs of the sensitive types to be used by the discovery job.

        If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

        Returns:
        the value

      • getSensitiveTypeGroupIdsForDiscovery

        public List<String> getSensitiveTypeGroupIdsForDiscovery()
        The OCIDs of the sensitive type groups to be used by the discovery job.

        All the sensitive types present in sensitive type group will be used for discovery.

        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 should be scanned by the discovery job.

        If it is set to true, sensitive data is discovered in all schemas (except for schemas maintained by Oracle). If both attributes are not provided, the configuration from the sensitive data model is used.

        Returns:
        the value

      • getIsIncludeAllSensitiveTypes

        public Boolean getIsIncludeAllSensitiveTypes()
        Indicates if all the existing sensitive types should be used by the discovery job.

        If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

        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

      • 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