CreateDiscoveryJobDetails

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

Bases: object

Details to create a new data discovery job.

Methods

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

Attributes

compartment_id [Required] Gets the compartment_id of this CreateDiscoveryJobDetails.
defined_tags Gets the defined_tags of this CreateDiscoveryJobDetails.
discovery_type Gets the discovery_type of this CreateDiscoveryJobDetails.
display_name Gets the display_name of this CreateDiscoveryJobDetails.
freeform_tags Gets the freeform_tags of this CreateDiscoveryJobDetails.
is_app_defined_relation_discovery_enabled Gets the is_app_defined_relation_discovery_enabled of this CreateDiscoveryJobDetails.
is_include_all_schemas Gets the is_include_all_schemas of this CreateDiscoveryJobDetails.
is_include_all_sensitive_types Gets the is_include_all_sensitive_types of this CreateDiscoveryJobDetails.
is_sample_data_collection_enabled Gets the is_sample_data_collection_enabled of this CreateDiscoveryJobDetails.
schemas_for_discovery Gets the schemas_for_discovery of this CreateDiscoveryJobDetails.
sensitive_data_model_id [Required] Gets the sensitive_data_model_id of this CreateDiscoveryJobDetails.
sensitive_type_ids_for_discovery Gets the sensitive_type_ids_for_discovery of this CreateDiscoveryJobDetails.
__init__(**kwargs)

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

Parameters:
  • discovery_type (str) – The value to assign to the discovery_type property of this CreateDiscoveryJobDetails.
  • sensitive_data_model_id (str) – The value to assign to the sensitive_data_model_id property of this CreateDiscoveryJobDetails.
  • compartment_id (str) – The value to assign to the compartment_id property of this CreateDiscoveryJobDetails.
  • display_name (str) – The value to assign to the display_name property of this CreateDiscoveryJobDetails.
  • schemas_for_discovery (list[str]) – The value to assign to the schemas_for_discovery property of this CreateDiscoveryJobDetails.
  • sensitive_type_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_ids_for_discovery property of this CreateDiscoveryJobDetails.
  • is_sample_data_collection_enabled (bool) – The value to assign to the is_sample_data_collection_enabled property of this CreateDiscoveryJobDetails.
  • is_app_defined_relation_discovery_enabled (bool) – The value to assign to the is_app_defined_relation_discovery_enabled property of this CreateDiscoveryJobDetails.
  • is_include_all_schemas (bool) – The value to assign to the is_include_all_schemas property of this CreateDiscoveryJobDetails.
  • is_include_all_sensitive_types (bool) – The value to assign to the is_include_all_sensitive_types property of this CreateDiscoveryJobDetails.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateDiscoveryJobDetails.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateDiscoveryJobDetails.
compartment_id

[Required] Gets the compartment_id of this CreateDiscoveryJobDetails. The OCID of the compartment where the discovery job resource should be created.

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

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

Gets the discovery_type of this CreateDiscoveryJobDetails. The type of the discovery job. It defines the job’s scope. NEW identifies new sensitive columns in the target database that are not in the sensitive data model. DELETED identifies columns that are present in the sensitive data model but have been deleted from the target database. MODIFIED identifies columns that are present in the target database as well as the sensitive data model but some of their attributes have been modified. ALL covers all the above three scenarios and reports new, deleted and modified columns.

Returns:The discovery_type of this CreateDiscoveryJobDetails.
Return type:str
display_name

Gets the display_name of this CreateDiscoveryJobDetails. A user-friendly name for the discovery job. Does not have to be unique, and it is changeable. Avoid entering confidential information.

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

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

Gets the is_app_defined_relation_discovery_enabled of this CreateDiscoveryJobDetails. Indicates if the discovery job 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 CreateDiscoveryJobDetails.
Return type:bool
is_include_all_schemas

Gets the is_include_all_schemas of this CreateDiscoveryJobDetails. Indicates if all the schemas should be scanned by the discovery job. If it’s set to true, the schemasForDiscovery attribute is ignored and all schemas are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

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

Gets the is_include_all_sensitive_types of this CreateDiscoveryJobDetails. Indicates if all the existing sensitive types should be used by the discovery job. If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used for data discovery. If both attributes are not provided, the configuration from the sensitive data model is used.

Returns:The is_include_all_sensitive_types of this CreateDiscoveryJobDetails.
Return type:bool
is_sample_data_collection_enabled

Gets the is_sample_data_collection_enabled of this CreateDiscoveryJobDetails. Indicates if the discovery job 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 CreateDiscoveryJobDetails.
Return type:bool
schemas_for_discovery

Gets the schemas_for_discovery of this CreateDiscoveryJobDetails. The schemas to be scanned by the discovery job. If not provided, the schemasForDiscovery attribute of the sensitive data model is used to get the list of schemas.

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

[Required] Gets the sensitive_data_model_id of this CreateDiscoveryJobDetails. The OCID of the sensitive data model.

Returns:The sensitive_data_model_id of this CreateDiscoveryJobDetails.
Return type:str
sensitive_type_ids_for_discovery

Gets the sensitive_type_ids_for_discovery of this CreateDiscoveryJobDetails. The OCIDs of the sensitive types to be used by the discovery job. If not provided, the sensitiveTypeIdsForDiscovery attribute of the sensitive data model is used to get the list of sensitive types.

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