SensitiveDataModel

class oci.data_safe.models.SensitiveDataModel(**kwargs)

Bases: object

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.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a SensitiveDataModel.
app_suite_name [Required] Gets the app_suite_name of this SensitiveDataModel.
compartment_id [Required] Gets the compartment_id of this SensitiveDataModel.
defined_tags Gets the defined_tags of this SensitiveDataModel.
description Gets the description of this SensitiveDataModel.
display_name [Required] Gets the display_name of this SensitiveDataModel.
freeform_tags Gets the freeform_tags of this SensitiveDataModel.
id [Required] Gets the id of this SensitiveDataModel.
is_app_defined_relation_discovery_enabled [Required] Gets the is_app_defined_relation_discovery_enabled of this SensitiveDataModel.
is_include_all_schemas [Required] Gets the is_include_all_schemas of this SensitiveDataModel.
is_include_all_sensitive_types [Required] Gets the is_include_all_sensitive_types of this SensitiveDataModel.
is_sample_data_collection_enabled [Required] Gets the is_sample_data_collection_enabled of this SensitiveDataModel.
lifecycle_state [Required] Gets the lifecycle_state of this SensitiveDataModel.
schemas_for_discovery Gets the schemas_for_discovery of this SensitiveDataModel.
sensitive_type_ids_for_discovery Gets the sensitive_type_ids_for_discovery of this SensitiveDataModel.
system_tags Gets the system_tags of this SensitiveDataModel.
target_id [Required] Gets the target_id of this SensitiveDataModel.
time_created [Required] Gets the time_created of this SensitiveDataModel.
time_updated [Required] Gets the time_updated of this SensitiveDataModel.

Methods

__init__(**kwargs) Initializes a new SensitiveDataModel object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a SensitiveDataModel. This constant has a value of “UPDATING”

__init__(**kwargs)

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

Parameters:
  • id (str) – The value to assign to the id property of this SensitiveDataModel.
  • display_name (str) – The value to assign to the display_name property of this SensitiveDataModel.
  • compartment_id (str) – The value to assign to the compartment_id property of this SensitiveDataModel.
  • target_id (str) – The value to assign to the target_id property of this SensitiveDataModel.
  • time_created (datetime) – The value to assign to the time_created property of this SensitiveDataModel.
  • time_updated (datetime) – The value to assign to the time_updated property of this SensitiveDataModel.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SensitiveDataModel. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
  • app_suite_name (str) – The value to assign to the app_suite_name property of this SensitiveDataModel.
  • description (str) – The value to assign to the description property of this SensitiveDataModel.
  • schemas_for_discovery (list[str]) – The value to assign to the schemas_for_discovery property of this SensitiveDataModel.
  • sensitive_type_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_ids_for_discovery property of this SensitiveDataModel.
  • is_sample_data_collection_enabled (bool) – The value to assign to the is_sample_data_collection_enabled property of this SensitiveDataModel.
  • is_app_defined_relation_discovery_enabled (bool) – The value to assign to the is_app_defined_relation_discovery_enabled property of this SensitiveDataModel.
  • is_include_all_schemas (bool) – The value to assign to the is_include_all_schemas property of this SensitiveDataModel.
  • is_include_all_sensitive_types (bool) – The value to assign to the is_include_all_sensitive_types property of this SensitiveDataModel.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SensitiveDataModel.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SensitiveDataModel.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SensitiveDataModel.
app_suite_name

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

[Required] Gets the compartment_id of this SensitiveDataModel. The OCID of the compartment that contains the sensitive data model.

Returns:The compartment_id of this SensitiveDataModel.
Return type:str
defined_tags

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

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

Returns:The description of this SensitiveDataModel.
Return type:str
display_name

[Required] Gets the display_name of this SensitiveDataModel. The display name of the sensitive data model.

Returns:The display_name of this SensitiveDataModel.
Return type:str
freeform_tags

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

[Required] Gets the id of this SensitiveDataModel. The OCID of the sensitive data model.

Returns:The id of this SensitiveDataModel.
Return type:str
is_app_defined_relation_discovery_enabled

[Required] Gets the is_app_defined_relation_discovery_enabled of this SensitiveDataModel. 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 SensitiveDataModel.
Return type:bool
is_include_all_schemas

[Required] Gets the is_include_all_schemas of this SensitiveDataModel. Indicates if all the schemas in the associated target database should be scanned by data discovery jobs. If it’s set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery.

Returns:The is_include_all_schemas of this SensitiveDataModel.
Return type:bool
is_include_all_sensitive_types

[Required] Gets the is_include_all_sensitive_types of this SensitiveDataModel. 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 SensitiveDataModel.
Return type:bool
is_sample_data_collection_enabled

[Required] Gets the is_sample_data_collection_enabled of this SensitiveDataModel. 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 SensitiveDataModel.
Return type:bool
lifecycle_state

[Required] Gets the lifecycle_state of this SensitiveDataModel. The current state of the sensitive data model.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this SensitiveDataModel.
Return type:str
schemas_for_discovery

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

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

Gets the sensitive_type_ids_for_discovery of this SensitiveDataModel. The OCIDs of the sensitive types to be used by data discovery jobs.

Returns:The sensitive_type_ids_for_discovery of this SensitiveDataModel.
Return type:list[str]
system_tags

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

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

[Required] Gets the time_created of this SensitiveDataModel. The date and time the sensitive data model was created, in the format defined by RFC3339.

Returns:The time_created of this SensitiveDataModel.
Return type:datetime
time_updated

[Required] Gets the time_updated of this SensitiveDataModel. The date and time the sensitive data model was last updated, in the format defined by RFC3339.

Returns:The time_updated of this SensitiveDataModel.
Return type:datetime