DiscoveryJob¶

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

Bases: object

A data discovery job. It helps track job’s metadata as well as result statistics.

Attributes

`DISCOVERY_TYPE_ALL`	A constant which can be used with the discovery_type property of a DiscoveryJob.
`DISCOVERY_TYPE_DELETED`	A constant which can be used with the discovery_type property of a DiscoveryJob.
`DISCOVERY_TYPE_MODIFIED`	A constant which can be used with the discovery_type property of a DiscoveryJob.
`DISCOVERY_TYPE_NEW`	A constant which can be used with the discovery_type property of a DiscoveryJob.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DiscoveryJob.
`compartment_id`	[Required] Gets the compartment_id of this DiscoveryJob.
`defined_tags`	Gets the defined_tags of this DiscoveryJob.
`discovery_type`	[Required] Gets the discovery_type of this DiscoveryJob.
`display_name`	[Required] Gets the display_name of this DiscoveryJob.
`freeform_tags`	Gets the freeform_tags of this DiscoveryJob.
`id`	[Required] Gets the id of this DiscoveryJob.
`is_app_defined_relation_discovery_enabled`	[Required] Gets the is_app_defined_relation_discovery_enabled of this DiscoveryJob.
`is_include_all_schemas`	[Required] Gets the is_include_all_schemas of this DiscoveryJob.
`is_include_all_sensitive_types`	[Required] Gets the is_include_all_sensitive_types of this DiscoveryJob.
`is_sample_data_collection_enabled`	[Required] Gets the is_sample_data_collection_enabled of this DiscoveryJob.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DiscoveryJob.
`schemas_for_discovery`	Gets the schemas_for_discovery of this DiscoveryJob.
`sensitive_data_model_id`	[Required] Gets the sensitive_data_model_id of this DiscoveryJob.
`sensitive_type_ids_for_discovery`	Gets the sensitive_type_ids_for_discovery of this DiscoveryJob.
`system_tags`	Gets the system_tags of this DiscoveryJob.
`target_id`	[Required] Gets the target_id of this DiscoveryJob.
`time_finished`	[Required] Gets the time_finished of this DiscoveryJob.
`time_started`	[Required] Gets the time_started of this DiscoveryJob.
`total_columns_scanned`	[Required] Gets the total_columns_scanned of this DiscoveryJob.
`total_deleted_sensitive_columns`	[Required] Gets the total_deleted_sensitive_columns of this DiscoveryJob.
`total_modified_sensitive_columns`	[Required] Gets the total_modified_sensitive_columns of this DiscoveryJob.
`total_new_sensitive_columns`	[Required] Gets the total_new_sensitive_columns of this DiscoveryJob.
`total_objects_scanned`	[Required] Gets the total_objects_scanned of this DiscoveryJob.
`total_schemas_scanned`	[Required] Gets the total_schemas_scanned of this DiscoveryJob.

Methods

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

DISCOVERY_TYPE_ALL = 'ALL'¶: A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “ALL”

DISCOVERY_TYPE_DELETED = 'DELETED'¶: A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “DELETED”

DISCOVERY_TYPE_MODIFIED = 'MODIFIED'¶: A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “MODIFIED”

DISCOVERY_TYPE_NEW = 'NEW'¶: A constant which can be used with the discovery_type property of a DiscoveryJob. This constant has a value of “NEW”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DiscoveryJob. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new DiscoveryJob 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 DiscoveryJob.
discovery_type (str) – The value to assign to the discovery_type property of this DiscoveryJob. Allowed values for this property are: “ALL”, “NEW”, “MODIFIED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
display_name (str) – The value to assign to the display_name property of this DiscoveryJob.
compartment_id (str) – The value to assign to the compartment_id property of this DiscoveryJob.
time_started (datetime) – The value to assign to the time_started property of this DiscoveryJob.
time_finished (datetime) – The value to assign to the time_finished property of this DiscoveryJob.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DiscoveryJob. 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’.
sensitive_data_model_id (str) – The value to assign to the sensitive_data_model_id property of this DiscoveryJob.
target_id (str) – The value to assign to the target_id property of this DiscoveryJob.
schemas_for_discovery (list[str]) – The value to assign to the schemas_for_discovery property of this DiscoveryJob.
sensitive_type_ids_for_discovery (list[str]) – The value to assign to the sensitive_type_ids_for_discovery property of this DiscoveryJob.
is_sample_data_collection_enabled (bool) – The value to assign to the is_sample_data_collection_enabled property of this DiscoveryJob.
is_app_defined_relation_discovery_enabled (bool) – The value to assign to the is_app_defined_relation_discovery_enabled property of this DiscoveryJob.
is_include_all_schemas (bool) – The value to assign to the is_include_all_schemas property of this DiscoveryJob.
is_include_all_sensitive_types (bool) – The value to assign to the is_include_all_sensitive_types property of this DiscoveryJob.
total_schemas_scanned (int) – The value to assign to the total_schemas_scanned property of this DiscoveryJob.
total_objects_scanned (int) – The value to assign to the total_objects_scanned property of this DiscoveryJob.
total_columns_scanned (int) – The value to assign to the total_columns_scanned property of this DiscoveryJob.
total_new_sensitive_columns (int) – The value to assign to the total_new_sensitive_columns property of this DiscoveryJob.
total_modified_sensitive_columns (int) – The value to assign to the total_modified_sensitive_columns property of this DiscoveryJob.
total_deleted_sensitive_columns (int) – The value to assign to the total_deleted_sensitive_columns property of this DiscoveryJob.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DiscoveryJob.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DiscoveryJob.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DiscoveryJob.

compartment_id¶

[Required] Gets the compartment_id of this DiscoveryJob. The OCID of the compartment that contains the discovery job.

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

defined_tags¶

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

discovery_type¶

[Required] Gets the discovery_type of this DiscoveryJob. 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.

Allowed values for this property are: “ALL”, “NEW”, “MODIFIED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The discovery_type of this DiscoveryJob.
Return type:	str

display_name¶

[Required] Gets the display_name of this DiscoveryJob. The display name of the discovery job.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this DiscoveryJob. The OCID of the discovery job.

Returns:	The id of this DiscoveryJob.
Return type:	str

is_app_defined_relation_discovery_enabled¶

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

is_include_all_schemas¶

[Required] Gets the is_include_all_schemas of this DiscoveryJob. Indicates if all the schemas in the associated target database are used for data discovery. 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 DiscoveryJob.
Return type:	bool

is_include_all_sensitive_types¶

[Required] Gets the is_include_all_sensitive_types of this DiscoveryJob. Indicates if all the existing sensitive types are used for data discovery. If it’s set to true, the sensitiveTypeIdsForDiscovery attribute is ignored and all sensitive types are used.

Returns:	The is_include_all_sensitive_types of this DiscoveryJob.
Return type:	bool

is_sample_data_collection_enabled¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DiscoveryJob. The current state of the discovery job.

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 DiscoveryJob.
Return type:	str

schemas_for_discovery¶

Gets the schemas_for_discovery of this DiscoveryJob. The schemas used for data discovery.

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

sensitive_data_model_id¶

[Required] Gets the sensitive_data_model_id of this DiscoveryJob. The OCID of the sensitive data model associated with the discovery job.

Returns:	The sensitive_data_model_id of this DiscoveryJob.
Return type:	str

sensitive_type_ids_for_discovery¶

Gets the sensitive_type_ids_for_discovery of this DiscoveryJob. The OCIDs of the sensitive types used for data discovery.

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

system_tags¶

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

target_id¶

[Required] Gets the target_id of this DiscoveryJob. The OCID of the target database associated with the discovery job.

Returns:	The target_id of this DiscoveryJob.
Return type:	str

time_finished¶

[Required] Gets the time_finished of this DiscoveryJob. The date and time the discovery job finished, in the format defined by RFC3339..

Returns:	The time_finished of this DiscoveryJob.
Return type:	datetime

time_started¶

[Required] Gets the time_started of this DiscoveryJob. The date and time the discovery job started, in the format defined by RFC3339.

Returns:	The time_started of this DiscoveryJob.
Return type:	datetime

total_columns_scanned¶

[Required] Gets the total_columns_scanned of this DiscoveryJob. The total number of columns scanned by the discovery job.

Returns:	The total_columns_scanned of this DiscoveryJob.
Return type:	int

total_deleted_sensitive_columns¶

[Required] Gets the total_deleted_sensitive_columns of this DiscoveryJob. The total number of deleted sensitive columns identified by the discovery job.

Returns:	The total_deleted_sensitive_columns of this DiscoveryJob.
Return type:	int

total_modified_sensitive_columns¶

[Required] Gets the total_modified_sensitive_columns of this DiscoveryJob. The total number of modified sensitive columns identified by the discovery job.

Returns:	The total_modified_sensitive_columns of this DiscoveryJob.
Return type:	int

total_new_sensitive_columns¶

[Required] Gets the total_new_sensitive_columns of this DiscoveryJob. The total number of new sensitive columns identified by the discovery job.

Returns:	The total_new_sensitive_columns of this DiscoveryJob.
Return type:	int

total_objects_scanned¶

[Required] Gets the total_objects_scanned of this DiscoveryJob. The total number of objects (tables and editioning views) scanned by the discovery job.

Returns:	The total_objects_scanned of this DiscoveryJob.
Return type:	int

total_schemas_scanned¶

[Required] Gets the total_schemas_scanned of this DiscoveryJob. The total number of schemas scanned by the discovery job.

Returns:	The total_schemas_scanned of this DiscoveryJob.
Return type:	int