Package com.oracle.bmc.datasafe.model

Class SensitiveDataModel

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class SensitiveDataModel
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A sensitive data model is a collection of sensitive columns and their referential relationships.

    It helps understand the sensitive data landscape, track changes, and efficiently enable security controls such as data masking. It can be managed either manually or by performing sensitive data discovery on a reference target database. Learn more.
    Note: Objects should always be created or deserialized using the SensitiveDataModel.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 SensitiveDataModel.Builder, which maintain a set of all explicitly set fields called SensitiveDataModel.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

      • getId

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

      • getDisplayName

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

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the sensitive data model.
        Returns:
        the value

      • getTargetId

        public String getTargetId()
        The OCID of the reference target database 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

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the sensitive data model was created, in the format defined by RFC3339.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the sensitive data model was last updated, in the format defined by RFC3339.
        Returns:
        the value

      • getLifecycleState

        public DiscoveryLifecycleState getLifecycleState()
        The current state of the sensitive data model.
        Returns:
        the value

      • getAppSuiteName

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

        The default value is GENERIC. 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.
        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

      • 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

      • 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