@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
SensitiveDataModel.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
SensitiveDataModel(String id,
String displayName,
String compartmentId,
String targetId,
Date timeCreated,
Date timeUpdated,
DiscoveryLifecycleState lifecycleState,
String appSuiteName,
String description,
List<String> schemasForDiscovery,
List<TablesForDiscovery> tablesForDiscovery,
List<String> sensitiveTypeIdsForDiscovery,
Boolean isSampleDataCollectionEnabled,
Boolean isAppDefinedRelationDiscoveryEnabled,
Boolean isIncludeAllSchemas,
Boolean isIncludeAllSensitiveTypes,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static SensitiveDataModel.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getAppSuiteName()
The application suite name identifying a collection of applications.
|
String |
getCompartmentId()
The OCID of the compartment that contains the sensitive data model.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description of the sensitive data model.
|
String |
getDisplayName()
The display name of the sensitive data model.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the sensitive data model.
|
Boolean |
getIsAppDefinedRelationDiscoveryEnabled()
Indicates if data discovery jobs should identify potential application-level (non-dictionary)
referential relationships between columns.
|
Boolean |
getIsIncludeAllSchemas()
Indicates if all the schemas in the associated target database should be scanned by data
discovery jobs.
|
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.
|
Boolean |
getIsSampleDataCollectionEnabled()
Indicates if data discovery jobs should collect and store sample data values for the
discovered columns.
|
DiscoveryLifecycleState |
getLifecycleState()
The current state of the sensitive data model.
|
List<String> |
getSchemasForDiscovery()
The schemas to be scanned by data discovery jobs.
|
List<String> |
getSensitiveTypeIdsForDiscovery()
The OCIDs of the sensitive types to be used by data discovery jobs.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
List<TablesForDiscovery> |
getTablesForDiscovery()
The data discovery jobs will scan the tables specified here, including both schemas and
tables.
|
String |
getTargetId()
The OCID of the reference target database associated with the sensitive data model.
|
Date |
getTimeCreated()
The date and time the sensitive data model was created, in the format defined by
RFC3339.
|
Date |
getTimeUpdated()
The date and time the sensitive data model was last updated, in the format defined by
RFC3339.
|
int |
hashCode() |
SensitiveDataModel.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"id","displayName","compartmentId","targetId","timeCreated","timeUpdated","lifecycleState","appSuiteName","description","schemasForDiscovery","tablesForDiscovery","sensitiveTypeIdsForDiscovery","isSampleDataCollectionEnabled","isAppDefinedRelationDiscoveryEnabled","isIncludeAllSchemas","isIncludeAllSensitiveTypes","freeformTags","definedTags","systemTags"}) public SensitiveDataModel(String id, String displayName, String compartmentId, String targetId, Date timeCreated, Date timeUpdated, DiscoveryLifecycleState lifecycleState, String appSuiteName, String description, List<String> schemasForDiscovery, List<TablesForDiscovery> tablesForDiscovery, List<String> sensitiveTypeIdsForDiscovery, Boolean isSampleDataCollectionEnabled, Boolean isAppDefinedRelationDiscoveryEnabled, Boolean isIncludeAllSchemas, Boolean isIncludeAllSensitiveTypes, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static SensitiveDataModel.Builder builder()
Create a new builder.
public SensitiveDataModel.Builder toBuilder()
public String getId()
The OCID of the sensitive data model.
public String getDisplayName()
The display name of the sensitive data model.
public String getCompartmentId()
The OCID of the compartment that contains the sensitive data model.
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.
public Date getTimeCreated()
The date and time the sensitive data model was created, in the format defined by RFC3339.
public Date getTimeUpdated()
The date and time the sensitive data model was last updated, in the format defined by RFC3339.
public DiscoveryLifecycleState getLifecycleState()
The current state of the sensitive data model.
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.
public String getDescription()
The description of the sensitive data model.
public List<String> getSchemasForDiscovery()
The schemas to be scanned by data discovery jobs.
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”]}].
public List<String> getSensitiveTypeIdsForDiscovery()
The OCIDs of the sensitive types to be used by data discovery jobs.
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.
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.
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).
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.
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"}
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"}}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.