Package com.oracle.bmc.datasafe.model

Class UpdateSensitiveDataModelDetails

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

    Note that updating any attribute of a sensitive data model does not perform data discovery.
    Note: Objects should always be created or deserialized using the UpdateSensitiveDataModelDetails.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 UpdateSensitiveDataModelDetails.Builder, which maintain a set of all explicitly set fields called UpdateSensitiveDataModelDetails.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

      • UpdateSensitiveDataModelDetails

        @Deprecated
@ConstructorProperties({"displayName","targetId","appSuiteName","description","schemasForDiscovery","tablesForDiscovery","sensitiveTypeIdsForDiscovery","sensitiveTypeGroupIdsForDiscovery","isSampleDataCollectionEnabled","isAppDefinedRelationDiscoveryEnabled","freeformTags","definedTags"})
public UpdateSensitiveDataModelDetails​(String displayName,
                                       String targetId,
                                       String appSuiteName,
                                       String description,
                                       List<String> schemasForDiscovery,
                                       List<TablesForDiscovery> tablesForDiscovery,
                                       List<String> sensitiveTypeIdsForDiscovery,
                                       List<String> sensitiveTypeGroupIdsForDiscovery,
                                       Boolean isSampleDataCollectionEnabled,
                                       Boolean isAppDefinedRelationDiscoveryEnabled,
                                       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

      • 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. Note that updating the targetId attribute does not perform data discovery automatically.

        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 used for future 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 for future 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.
        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

      • 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