SensitiveColumn¶

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

Bases: object

A sensitive column is a resource corresponding to a database column that is considered sensitive. It’s a subresource of sensitive data model resource and is always associated with a sensitive data model. Note that referential relationships are also managed as part of sensitive columns.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a SensitiveColumn.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a SensitiveColumn.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a SensitiveColumn.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a SensitiveColumn.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a SensitiveColumn.
`OBJECT_TYPE_EDITIONING_VIEW`	A constant which can be used with the object_type property of a SensitiveColumn.
`OBJECT_TYPE_TABLE`	A constant which can be used with the object_type property of a SensitiveColumn.
`RELATION_TYPE_APP_DEFINED`	A constant which can be used with the relation_type property of a SensitiveColumn.
`RELATION_TYPE_DB_DEFINED`	A constant which can be used with the relation_type property of a SensitiveColumn.
`RELATION_TYPE_NONE`	A constant which can be used with the relation_type property of a SensitiveColumn.
`SOURCE_DISCOVERY`	A constant which can be used with the source property of a SensitiveColumn.
`SOURCE_MANUAL`	A constant which can be used with the source property of a SensitiveColumn.
`STATUS_INVALID`	A constant which can be used with the status property of a SensitiveColumn.
`STATUS_VALID`	A constant which can be used with the status property of a SensitiveColumn.
`app_defined_child_column_keys`	Gets the app_defined_child_column_keys of this SensitiveColumn.
`app_name`	[Required] Gets the app_name of this SensitiveColumn.
`column_groups`	Gets the column_groups of this SensitiveColumn.
`column_name`	[Required] Gets the column_name of this SensitiveColumn.
`data_type`	[Required] Gets the data_type of this SensitiveColumn.
`db_defined_child_column_keys`	Gets the db_defined_child_column_keys of this SensitiveColumn.
`estimated_data_value_count`	[Required] Gets the estimated_data_value_count of this SensitiveColumn.
`key`	[Required] Gets the key of this SensitiveColumn.
`lifecycle_details`	Gets the lifecycle_details of this SensitiveColumn.
`lifecycle_state`	[Required] Gets the lifecycle_state of this SensitiveColumn.
`object_name`	[Required] Gets the object_name of this SensitiveColumn.
`object_type`	[Required] Gets the object_type of this SensitiveColumn.
`parent_column_keys`	Gets the parent_column_keys of this SensitiveColumn.
`relation_type`	[Required] Gets the relation_type of this SensitiveColumn.
`sample_data_values`	Gets the sample_data_values of this SensitiveColumn.
`schema_name`	[Required] Gets the schema_name of this SensitiveColumn.
`sensitive_data_model_id`	[Required] Gets the sensitive_data_model_id of this SensitiveColumn.
`sensitive_type_id`	Gets the sensitive_type_id of this SensitiveColumn.
`source`	[Required] Gets the source of this SensitiveColumn.
`status`	[Required] Gets the status of this SensitiveColumn.
`time_created`	[Required] Gets the time_created of this SensitiveColumn.
`time_updated`	[Required] Gets the time_updated of this SensitiveColumn.

Methods

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

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

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

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

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

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

OBJECT_TYPE_EDITIONING_VIEW = 'EDITIONING_VIEW'¶: A constant which can be used with the object_type property of a SensitiveColumn. 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 SensitiveColumn. This constant has a value of “TABLE”

RELATION_TYPE_APP_DEFINED = 'APP_DEFINED'¶: A constant which can be used with the relation_type property of a SensitiveColumn. 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 SensitiveColumn. 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 SensitiveColumn. This constant has a value of “NONE”

SOURCE_DISCOVERY = 'DISCOVERY'¶: A constant which can be used with the source property of a SensitiveColumn. This constant has a value of “DISCOVERY”

SOURCE_MANUAL = 'MANUAL'¶: A constant which can be used with the source property of a SensitiveColumn. This constant has a value of “MANUAL”

STATUS_INVALID = 'INVALID'¶: A constant which can be used with the status property of a SensitiveColumn. This constant has a value of “INVALID”

STATUS_VALID = 'VALID'¶: A constant which can be used with the status property of a SensitiveColumn. This constant has a value of “VALID”

__init__(**kwargs)¶

Initializes a new SensitiveColumn 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 SensitiveColumn.
sensitive_data_model_id (str) – The value to assign to the sensitive_data_model_id property of this SensitiveColumn.
time_created (datetime) – The value to assign to the time_created property of this SensitiveColumn.
time_updated (datetime) – The value to assign to the time_updated property of this SensitiveColumn.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this SensitiveColumn. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this SensitiveColumn.
app_name (str) – The value to assign to the app_name property of this SensitiveColumn.
schema_name (str) – The value to assign to the schema_name property of this SensitiveColumn.
object_name (str) – The value to assign to the object_name property of this SensitiveColumn.
column_name (str) – The value to assign to the column_name property of this SensitiveColumn.
object_type (str) – The value to assign to the object_type property of this SensitiveColumn. 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 SensitiveColumn.
status (str) – The value to assign to the status property of this SensitiveColumn. Allowed values for this property are: “VALID”, “INVALID”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this SensitiveColumn.
source (str) – The value to assign to the source property of this SensitiveColumn. Allowed values for this property are: “MANUAL”, “DISCOVERY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parent_column_keys (list[str]) – The value to assign to the parent_column_keys property of this SensitiveColumn.
relation_type (str) – The value to assign to the relation_type property of this SensitiveColumn. 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 SensitiveColumn.
sample_data_values (list[str]) – The value to assign to the sample_data_values property of this SensitiveColumn.
app_defined_child_column_keys (list[str]) – The value to assign to the app_defined_child_column_keys property of this SensitiveColumn.
db_defined_child_column_keys (list[str]) – The value to assign to the db_defined_child_column_keys property of this SensitiveColumn.
column_groups (list[str]) – The value to assign to the column_groups property of this SensitiveColumn.

app_defined_child_column_keys¶

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

app_name¶

[Required] Gets the app_name of this SensitiveColumn. The name of the application associated with the sensitive column. It’s useful when the application name is different from the schema name. Otherwise, it can be ignored.

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

column_groups¶

Gets the column_groups of this SensitiveColumn. The composite key groups to which the sensitive column belongs. If the column is part of a composite key, it’s assigned a column group. It helps identify and manage referential relationships that involve composite keys.

Returns:	The column_groups of this SensitiveColumn.
Return type:	list[str]

column_name¶

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

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

data_type¶

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

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

db_defined_child_column_keys¶

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

estimated_data_value_count¶

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

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

key¶

[Required] Gets the key of this SensitiveColumn. The unique key that identifies the sensitive column. It’s numeric and unique within a sensitive data model.

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

lifecycle_details¶

Gets the lifecycle_details of this SensitiveColumn. Details about the current state of the sensitive column.

Returns:	The lifecycle_details of this SensitiveColumn.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this SensitiveColumn. The current state of the sensitive column.

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

Returns:	The lifecycle_state of this SensitiveColumn.
Return type:	str

object_name¶

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

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

object_type¶

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

parent_column_keys¶

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

relation_type¶

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

sample_data_values¶

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

schema_name¶

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

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

sensitive_data_model_id¶

[Required] Gets the sensitive_data_model_id of this SensitiveColumn. The OCID of the sensitive data model that contains the sensitive column.

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

sensitive_type_id¶

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

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

source¶

[Required] Gets the source of this SensitiveColumn. The source of the sensitive column. DISCOVERY indicates that the column was added to the sensitive data model using a data discovery job. MANUAL indicates that the column was added manually.

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

Returns:	The source of this SensitiveColumn.
Return type:	str

status¶

[Required] Gets the status of this SensitiveColumn. The status of the sensitive column. VALID means the column is considered sensitive. INVALID means the column is not considered sensitive. Tracking invalid columns in a sensitive data model helps ensure that an incremental data discovery job does not identify these columns as sensitive again.

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

Returns:	The status of this SensitiveColumn.
Return type:	str

time_created¶

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

Returns:	The time_created of this SensitiveColumn.
Return type:	datetime

time_updated¶

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

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