Package com.oracle.bmc.datasafe.model

Class CreateSensitiveDataModelDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CreateSensitiveDataModelDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Details to create a new sensitive data model.

    If schemas and sensitive types are provided, it automatically runs data discovery and adds the discovered columns to the sensitive data model. Otherwise, it creates an empty sensitive data model that can be updated later. To specify some schemas and sensitive types for data discovery, use schemasForDiscovery and sensitiveTypeIdsForDiscovery attributes. But if you want to include all schemas and sensitive types, you can set isIncludeAllSchemas and isIncludeAllSensitiveTypes attributes to true. In the latter case, you do not need to list all schemas and sensitive types.
    Note: Objects should always be created or deserialized using the CreateSensitiveDataModelDetails.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 CreateSensitiveDataModelDetails.Builder, which maintain a set of all explicitly set fields called CreateSensitiveDataModelDetails.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

      • CreateSensitiveDataModelDetails

        @Deprecated
@ConstructorProperties({"displayName","compartmentId","targetId","appSuiteName","description","schemasForDiscovery","tablesForDiscovery","sensitiveTypeIdsForDiscovery","sensitiveTypeGroupIdsForDiscovery","isSampleDataCollectionEnabled","isAppDefinedRelationDiscoveryEnabled","isIncludeAllSchemas","isIncludeAllSensitiveTypes","freeformTags","definedTags"})
public CreateSensitiveDataModelDetails​(String displayName,
                                       String compartmentId,
                                       String targetId,
                                       String appSuiteName,
                                       String description,
                                       List<String> schemasForDiscovery,
                                       List<TablesForDiscovery> tablesForDiscovery,
                                       List<String> sensitiveTypeIdsForDiscovery,
                                       List<String> sensitiveTypeGroupIdsForDiscovery,
                                       Boolean isSampleDataCollectionEnabled,
                                       Boolean isAppDefinedRelationDiscoveryEnabled,
                                       Boolean isIncludeAllSchemas,
                                       Boolean isIncludeAllSensitiveTypes,
                                       Map<String,​String> freeformTags,
                                       Map<String,​Map<String,​Object>> definedTags)
        Deprecated.

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        The display name of the sensitive data model.

        The name does not have to be unique, and it’s changeable.

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment where the sensitive data model should be created.
        Returns:
        the value

      • getTargetId

        public String getTargetId()
        The OCID of the reference target database to be associated with the sensitive data model.

        All operations such as performing data discovery and adding columns manually are done in the context of the associated target database.

        Returns:
        the value

      • getAppSuiteName

        public String getAppSuiteName()
        The application suite name identifying a collection of applications.

        It’s useful only if maintaining a sensitive data model for a suite of applications.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description of the sensitive data model.
        Returns:
        the value

      • getSchemasForDiscovery

        public List<String> getSchemasForDiscovery()
        The schemas to be scanned by data discovery jobs.
        Returns:
        the value

      • getTablesForDiscovery

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

        For instance, the input could be in the format: [{schemaName: “HR”, tableName: [“T1”, “T2”]}, {schemaName: “OE”, tableName : [“T3”, “T4”]}].

        Returns:
        the value

      • getSensitiveTypeIdsForDiscovery

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

        If OCID of a sensitive category is provided, all its child sensitive types are 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.

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

        Returns:
        the value

      • getIsSampleDataCollectionEnabled

        public Boolean getIsSampleDataCollectionEnabled()
        Indicates if data discovery jobs 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 data discovery jobs 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 should be scanned by data discovery jobs.

        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 should be used by data discovery jobs.

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

        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