CreateSensitiveDataModelDetails¶

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

Bases: object

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.

Methods:

__init__(**kwargs)

Initializes a new CreateSensitiveDataModelDetails object with values from keyword arguments.

Attributes:

`app_suite_name`	Gets the app_suite_name of this CreateSensitiveDataModelDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateSensitiveDataModelDetails.
`defined_tags`	Gets the defined_tags of this CreateSensitiveDataModelDetails.
`description`	Gets the description of this CreateSensitiveDataModelDetails.
`display_name`	Gets the display_name of this CreateSensitiveDataModelDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSensitiveDataModelDetails.
`is_app_defined_relation_discovery_enabled`	Gets the is_app_defined_relation_discovery_enabled of this CreateSensitiveDataModelDetails.
`is_include_all_schemas`	Gets the is_include_all_schemas of this CreateSensitiveDataModelDetails.
`is_include_all_sensitive_types`	Gets the is_include_all_sensitive_types of this CreateSensitiveDataModelDetails.
`is_sample_data_collection_enabled`	Gets the is_sample_data_collection_enabled of this CreateSensitiveDataModelDetails.
`schemas_for_discovery`	Gets the schemas_for_discovery of this CreateSensitiveDataModelDetails.
`sensitive_type_group_ids_for_discovery`	Gets the sensitive_type_group_ids_for_discovery of this CreateSensitiveDataModelDetails.
`sensitive_type_ids_for_discovery`	Gets the sensitive_type_ids_for_discovery of this CreateSensitiveDataModelDetails.
`tables_for_discovery`	Gets the tables_for_discovery of this CreateSensitiveDataModelDetails.
`target_id`	[Required] Gets the target_id of this CreateSensitiveDataModelDetails.

__init__(**kwargs)¶

Initializes a new CreateSensitiveDataModelDetails 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 CreateSensitiveDataModelDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateSensitiveDataModelDetails.
target_id (str) – The value to assign to the target_id property of this CreateSensitiveDataModelDetails.
app_suite_name (str) – The value to assign to the app_suite_name property of this CreateSensitiveDataModelDetails.
description (str) – The value to assign to the description property of this CreateSensitiveDataModelDetails.
schemas_for_discovery (list[str]) – The value to assign to the schemas_for_discovery property of this CreateSensitiveDataModelDetails.
tables_for_discovery (list[oci.data_safe.models.TablesForDiscovery]) – The value to assign to the tables_for_discovery property of this CreateSensitiveDataModelDetails.
sensitive_type_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_ids_for_discovery property of this CreateSensitiveDataModelDetails.
sensitive_type_group_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_group_ids_for_discovery property of this CreateSensitiveDataModelDetails.
is_sample_data_collection_enabled (bool) – The value to assign to the is_sample_data_collection_enabled property of this CreateSensitiveDataModelDetails.
is_app_defined_relation_discovery_enabled (bool) – The value to assign to the is_app_defined_relation_discovery_enabled property of this CreateSensitiveDataModelDetails.
is_include_all_schemas (bool) – The value to assign to the is_include_all_schemas property of this CreateSensitiveDataModelDetails.
is_include_all_sensitive_types (bool) – The value to assign to the is_include_all_sensitive_types property of this CreateSensitiveDataModelDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSensitiveDataModelDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSensitiveDataModelDetails.

property app_suite_name¶

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

property compartment_id¶

[Required] Gets the compartment_id of this CreateSensitiveDataModelDetails. The OCID of the compartment where the sensitive data model should be created.

Returns: The compartment_id of this CreateSensitiveDataModelDetails.
Return type: str

property defined_tags¶

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

property description¶

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

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

property display_name¶

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

property freeform_tags¶

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

property is_app_defined_relation_discovery_enabled¶

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

property is_include_all_schemas¶

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

property is_include_all_sensitive_types¶

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

property is_sample_data_collection_enabled¶

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

property schemas_for_discovery¶

Gets the schemas_for_discovery of this CreateSensitiveDataModelDetails. The schemas to be scanned by data discovery jobs.

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

property sensitive_type_group_ids_for_discovery¶

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

property sensitive_type_ids_for_discovery¶

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

property tables_for_discovery¶

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

property target_id¶

[Required] Gets the target_id of this CreateSensitiveDataModelDetails. 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 target_id of this CreateSensitiveDataModelDetails.
Return type: str