DiscoveryJobResult¶

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

Bases: object

A discovery job result representing a sensitive column. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

Attributes

`DISCOVERY_TYPE_DELETED`	A constant which can be used with the discovery_type property of a DiscoveryJobResult.
`DISCOVERY_TYPE_MODIFIED`	A constant which can be used with the discovery_type property of a DiscoveryJobResult.
`DISCOVERY_TYPE_NEW`	A constant which can be used with the discovery_type property of a DiscoveryJobResult.
`OBJECT_TYPE_EDITIONING_VIEW`	A constant which can be used with the object_type property of a DiscoveryJobResult.
`OBJECT_TYPE_TABLE`	A constant which can be used with the object_type property of a DiscoveryJobResult.
`PLANNED_ACTION_ACCEPT`	A constant which can be used with the planned_action property of a DiscoveryJobResult.
`PLANNED_ACTION_INVALIDATE`	A constant which can be used with the planned_action property of a DiscoveryJobResult.
`PLANNED_ACTION_NONE`	A constant which can be used with the planned_action property of a DiscoveryJobResult.
`PLANNED_ACTION_REJECT`	A constant which can be used with the planned_action property of a DiscoveryJobResult.
`RELATION_TYPE_APP_DEFINED`	A constant which can be used with the relation_type property of a DiscoveryJobResult.
`RELATION_TYPE_DB_DEFINED`	A constant which can be used with the relation_type property of a DiscoveryJobResult.
`RELATION_TYPE_NONE`	A constant which can be used with the relation_type property of a DiscoveryJobResult.
`app_defined_child_column_keys`	Gets the app_defined_child_column_keys of this DiscoveryJobResult.
`app_name`	Gets the app_name of this DiscoveryJobResult.
`column_name`	[Required] Gets the column_name of this DiscoveryJobResult.
`data_type`	[Required] Gets the data_type of this DiscoveryJobResult.
`db_defined_child_column_keys`	Gets the db_defined_child_column_keys of this DiscoveryJobResult.
`discovery_job_id`	[Required] Gets the discovery_job_id of this DiscoveryJobResult.
`discovery_type`	[Required] Gets the discovery_type of this DiscoveryJobResult.
`estimated_data_value_count`	[Required] Gets the estimated_data_value_count of this DiscoveryJobResult.
`is_result_applied`	[Required] Gets the is_result_applied of this DiscoveryJobResult.
`key`	[Required] Gets the key of this DiscoveryJobResult.
`modified_attributes`	Gets the modified_attributes of this DiscoveryJobResult.
`object_name`	[Required] Gets the object_name of this DiscoveryJobResult.
`object_type`	[Required] Gets the object_type of this DiscoveryJobResult.
`parent_column_keys`	Gets the parent_column_keys of this DiscoveryJobResult.
`planned_action`	[Required] Gets the planned_action of this DiscoveryJobResult.
`relation_type`	[Required] Gets the relation_type of this DiscoveryJobResult.
`sample_data_values`	Gets the sample_data_values of this DiscoveryJobResult.
`schema_name`	[Required] Gets the schema_name of this DiscoveryJobResult.
`sensitive_columnkey`	Gets the sensitive_columnkey of this DiscoveryJobResult.
`sensitive_type_id`	Gets the sensitive_type_id of this DiscoveryJobResult.

Methods

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

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

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

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

OBJECT_TYPE_EDITIONING_VIEW = 'EDITIONING_VIEW'¶: A constant which can be used with the object_type property of a DiscoveryJobResult. This constant has a value of “EDITIONING_VIEW”

OBJECT_TYPE_TABLE = 'TABLE'¶: A constant which can be used with the object_type property of a DiscoveryJobResult. This constant has a value of “TABLE”

PLANNED_ACTION_ACCEPT = 'ACCEPT'¶: A constant which can be used with the planned_action property of a DiscoveryJobResult. This constant has a value of “ACCEPT”

PLANNED_ACTION_INVALIDATE = 'INVALIDATE'¶: A constant which can be used with the planned_action property of a DiscoveryJobResult. This constant has a value of “INVALIDATE”

PLANNED_ACTION_NONE = 'NONE'¶: A constant which can be used with the planned_action property of a DiscoveryJobResult. This constant has a value of “NONE”

PLANNED_ACTION_REJECT = 'REJECT'¶: A constant which can be used with the planned_action property of a DiscoveryJobResult. This constant has a value of “REJECT”

RELATION_TYPE_APP_DEFINED = 'APP_DEFINED'¶: A constant which can be used with the relation_type property of a DiscoveryJobResult. This constant has a value of “APP_DEFINED”

RELATION_TYPE_DB_DEFINED = 'DB_DEFINED'¶: A constant which can be used with the relation_type property of a DiscoveryJobResult. This constant has a value of “DB_DEFINED”

RELATION_TYPE_NONE = 'NONE'¶: A constant which can be used with the relation_type property of a DiscoveryJobResult. This constant has a value of “NONE”

__init__(**kwargs)¶

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

Parameters:

key (str) – The value to assign to the key property of this DiscoveryJobResult.
discovery_type (str) – The value to assign to the discovery_type property of this DiscoveryJobResult. Allowed values for this property are: “NEW”, “MODIFIED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sensitive_columnkey (str) – The value to assign to the sensitive_columnkey property of this DiscoveryJobResult.
app_name (str) – The value to assign to the app_name property of this DiscoveryJobResult.
schema_name (str) – The value to assign to the schema_name property of this DiscoveryJobResult.
object_name (str) – The value to assign to the object_name property of this DiscoveryJobResult.
column_name (str) – The value to assign to the column_name property of this DiscoveryJobResult.
object_type (str) – The value to assign to the object_type property of this DiscoveryJobResult. Allowed values for this property are: “TABLE”, “EDITIONING_VIEW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
data_type (str) – The value to assign to the data_type property of this DiscoveryJobResult.
sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this DiscoveryJobResult.
parent_column_keys (list[str]) – The value to assign to the parent_column_keys property of this DiscoveryJobResult.
relation_type (str) – The value to assign to the relation_type property of this DiscoveryJobResult. Allowed values for this property are: “NONE”, “APP_DEFINED”, “DB_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
estimated_data_value_count (int) – The value to assign to the estimated_data_value_count property of this DiscoveryJobResult.
sample_data_values (list[str]) – The value to assign to the sample_data_values property of this DiscoveryJobResult.
app_defined_child_column_keys (list[str]) – The value to assign to the app_defined_child_column_keys property of this DiscoveryJobResult.
db_defined_child_column_keys (list[str]) – The value to assign to the db_defined_child_column_keys property of this DiscoveryJobResult.
planned_action (str) – The value to assign to the planned_action property of this DiscoveryJobResult. Allowed values for this property are: “NONE”, “ACCEPT”, “INVALIDATE”, “REJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
is_result_applied (bool) – The value to assign to the is_result_applied property of this DiscoveryJobResult.
discovery_job_id (str) – The value to assign to the discovery_job_id property of this DiscoveryJobResult.
modified_attributes (oci.data_safe.models.ModifiedAttributes) – The value to assign to the modified_attributes property of this DiscoveryJobResult.

app_defined_child_column_keys¶

Gets the app_defined_child_column_keys of this DiscoveryJobResult. Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column.

Returns:	The app_defined_child_column_keys of this DiscoveryJobResult.
Return type:	list[str]

app_name¶

Gets the app_name of this DiscoveryJobResult. The name of the application. An application is an entity that is identified by a schema and stores sensitive information for that schema. Its value will be same as schemaName, if no value is passed.

Returns:	The app_name of this DiscoveryJobResult.
Return type:	str

column_name¶

[Required] Gets the column_name of this DiscoveryJobResult. The name of the sensitive column.

Returns:	The column_name of this DiscoveryJobResult.
Return type:	str

data_type¶

[Required] Gets the data_type of this DiscoveryJobResult. The data type of the sensitive column.

Returns:	The data_type of this DiscoveryJobResult.
Return type:	str

db_defined_child_column_keys¶

Gets the db_defined_child_column_keys of this DiscoveryJobResult. Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column.

Returns:	The db_defined_child_column_keys of this DiscoveryJobResult.
Return type:	list[str]

discovery_job_id¶

[Required] Gets the discovery_job_id of this DiscoveryJobResult. The OCID of the discovery job.

Returns:	The discovery_job_id of this DiscoveryJobResult.
Return type:	str

discovery_type¶

[Required] Gets the discovery_type of this DiscoveryJobResult. The type of the discovery result. It can be one of the following three types: NEW: A new sensitive column in the target database that is not in the sensitive data model. DELETED: A column that is present in the sensitive data model but has been deleted from the target database. MODIFIED: A column that is present in the target database as well as the sensitive data model but some of its attributes have been modified.

Allowed values for this property are: “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 DiscoveryJobResult.
Return type:	str

estimated_data_value_count¶

[Required] Gets the estimated_data_value_count of this DiscoveryJobResult. The estimated number of data values the column has in the associated database.

Returns:	The estimated_data_value_count of this DiscoveryJobResult.
Return type:	int

is_result_applied¶

[Required] Gets the is_result_applied of this DiscoveryJobResult. Indicates whether the discovery result has been processed. You can update this attribute using the PatchDiscoveryJobResults operation to track whether the discovery result has already been processed and applied to the sensitive data model.

Returns:	The is_result_applied of this DiscoveryJobResult.
Return type:	bool

key¶

[Required] Gets the key of this DiscoveryJobResult. The unique key that identifies the discovery result.

Returns:	The key of this DiscoveryJobResult.
Return type:	str

modified_attributes¶

Gets the modified_attributes of this DiscoveryJobResult.

Returns:	The modified_attributes of this DiscoveryJobResult.
Return type:	oci.data_safe.models.ModifiedAttributes

object_name¶

[Required] Gets the object_name of this DiscoveryJobResult. The database object that contains the sensitive column.

Returns:	The object_name of this DiscoveryJobResult.
Return type:	str

object_type¶

[Required] Gets the object_type of this DiscoveryJobResult. The type of the database object that contains the sensitive column.

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

Returns:	The object_type of this DiscoveryJobResult.
Return type:	str

parent_column_keys¶

Gets the parent_column_keys of this DiscoveryJobResult. Unique keys identifying the columns that are parents of the sensitive column. At present, it tracks a single parent only.

Returns:	The parent_column_keys of this DiscoveryJobResult.
Return type:	list[str]

planned_action¶

[Required] Gets the planned_action of this DiscoveryJobResult. Specifies how to process the discovery result. It’s set to NONE by default. Use the PatchDiscoveryJobResults operation to update this attribute. You can choose one of the following options: ACCEPT: To accept the discovery result and update the sensitive data model to reflect the changes. REJECT: To reject the discovery result so that it doesn’t change the sensitive data model. INVALIDATE: To invalidate a newly discovered column. It adds the column to the sensitive data model but marks it as invalid. It helps track false positives and ensure that they aren’t reported by future discovery jobs. After specifying the planned action, you can use the ApplyDiscoveryJobResults operation to automatically process the discovery results.

Allowed values for this property are: “NONE”, “ACCEPT”, “INVALIDATE”, “REJECT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The planned_action of this DiscoveryJobResult.
Return type:	str

relation_type¶

[Required] Gets the relation_type of this DiscoveryJobResult. The type of referential relationship the sensitive column has with its parent. NONE indicates that the sensitive column does not have a parent. DB_DEFINED indicates that the relationship is defined in the database dictionary. APP_DEFINED indicates that the relationship is defined at the application level and not in the database dictionary.

Allowed values for this property are: “NONE”, “APP_DEFINED”, “DB_DEFINED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The relation_type of this DiscoveryJobResult.
Return type:	str

sample_data_values¶

Gets the sample_data_values of this DiscoveryJobResult. Original data values collected for the sensitive column from the associated database. Sample data helps review the column and ensure that it actually contains sensitive data. Note that sample data is retrieved by a data discovery job only if the isSampleDataCollectionEnabled attribute is set to true. At present, only one data value is collected per sensitive column.

Returns:	The sample_data_values of this DiscoveryJobResult.
Return type:	list[str]

schema_name¶

[Required] Gets the schema_name of this DiscoveryJobResult. The database schema that contains the sensitive column.

Returns:	The schema_name of this DiscoveryJobResult.
Return type:	str

sensitive_columnkey¶

Gets the sensitive_columnkey of this DiscoveryJobResult. The unique key that identifies the sensitive column represented by the discovery result.

Returns:	The sensitive_columnkey of this DiscoveryJobResult.
Return type:	str

sensitive_type_id¶

Gets the sensitive_type_id of this DiscoveryJobResult. The OCID of the sensitive type associated with the sensitive column.

Returns:	The sensitive_type_id of this DiscoveryJobResult.
Return type:	str