UpdateSensitiveDataModelDetails¶

class oci.data_safe.models.UpdateSensitiveDataModelDetails(**kwargs)¶

Bases: object

Details to update a sensitive data model. Note that updating any attribute of a sensitive data model does not perform data discovery.

Methods

__init__(**kwargs) Initializes a new UpdateSensitiveDataModelDetails object with values from keyword arguments.

Attributes

`app_suite_name`	Gets the app_suite_name of this UpdateSensitiveDataModelDetails.
`defined_tags`	Gets the defined_tags of this UpdateSensitiveDataModelDetails.
`description`	Gets the description of this UpdateSensitiveDataModelDetails.
`display_name`	Gets the display_name of this UpdateSensitiveDataModelDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateSensitiveDataModelDetails.
`is_app_defined_relation_discovery_enabled`	Gets the is_app_defined_relation_discovery_enabled of this UpdateSensitiveDataModelDetails.
`is_sample_data_collection_enabled`	Gets the is_sample_data_collection_enabled of this UpdateSensitiveDataModelDetails.
`schemas_for_discovery`	Gets the schemas_for_discovery of this UpdateSensitiveDataModelDetails.
`sensitive_type_ids_for_discovery`	Gets the sensitive_type_ids_for_discovery of this UpdateSensitiveDataModelDetails.
`tables_for_discovery`	Gets the tables_for_discovery of this UpdateSensitiveDataModelDetails.
`target_id`	Gets the target_id of this UpdateSensitiveDataModelDetails.

__init__(**kwargs)¶

Initializes a new UpdateSensitiveDataModelDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this UpdateSensitiveDataModelDetails.
target_id (str) – The value to assign to the target_id property of this UpdateSensitiveDataModelDetails.
app_suite_name (str) – The value to assign to the app_suite_name property of this UpdateSensitiveDataModelDetails.
description (str) – The value to assign to the description property of this UpdateSensitiveDataModelDetails.
schemas_for_discovery (list[str]) – The value to assign to the schemas_for_discovery property of this UpdateSensitiveDataModelDetails.
tables_for_discovery (list[oci.data_safe.models.TablesForDiscovery]) – The value to assign to the tables_for_discovery property of this UpdateSensitiveDataModelDetails.
sensitive_type_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_ids_for_discovery property of this UpdateSensitiveDataModelDetails.
is_sample_data_collection_enabled (bool) – The value to assign to the is_sample_data_collection_enabled property of this UpdateSensitiveDataModelDetails.
is_app_defined_relation_discovery_enabled (bool) – The value to assign to the is_app_defined_relation_discovery_enabled property of this UpdateSensitiveDataModelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateSensitiveDataModelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateSensitiveDataModelDetails.

app_suite_name¶

Gets the app_suite_name of this UpdateSensitiveDataModelDetails. 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 app_suite_name of this UpdateSensitiveDataModelDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this UpdateSensitiveDataModelDetails. 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 defined_tags of this UpdateSensitiveDataModelDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this UpdateSensitiveDataModelDetails. The description of the sensitive data model.

Returns:	The description of this UpdateSensitiveDataModelDetails.
Return type:	str

display_name¶

Gets the display_name of this UpdateSensitiveDataModelDetails. The display name of the sensitive data model. The name does not have to be unique, and it’s changeable.

Returns:	The display_name of this UpdateSensitiveDataModelDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this UpdateSensitiveDataModelDetails. 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 freeform_tags of this UpdateSensitiveDataModelDetails.
Return type:	dict(str, str)

is_app_defined_relation_discovery_enabled¶

Gets the is_app_defined_relation_discovery_enabled of this UpdateSensitiveDataModelDetails. 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 is_app_defined_relation_discovery_enabled of this UpdateSensitiveDataModelDetails.
Return type:	bool

is_sample_data_collection_enabled¶

Gets the is_sample_data_collection_enabled of this UpdateSensitiveDataModelDetails. 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 is_sample_data_collection_enabled of this UpdateSensitiveDataModelDetails.
Return type:	bool

schemas_for_discovery¶

Gets the schemas_for_discovery of this UpdateSensitiveDataModelDetails. The schemas to be used for future data discovery jobs.

Returns:	The schemas_for_discovery of this UpdateSensitiveDataModelDetails.
Return type:	list[str]

sensitive_type_ids_for_discovery¶

Gets the sensitive_type_ids_for_discovery of this UpdateSensitiveDataModelDetails. 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 sensitive_type_ids_for_discovery of this UpdateSensitiveDataModelDetails.
Return type:	list[str]

tables_for_discovery¶

Gets the tables_for_discovery of this UpdateSensitiveDataModelDetails. 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 tables_for_discovery of this UpdateSensitiveDataModelDetails.
Return type:	list[oci.data_safe.models.TablesForDiscovery]

target_id¶

Gets the target_id of this UpdateSensitiveDataModelDetails. 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 target_id of this UpdateSensitiveDataModelDetails.
Return type:	str