CreateSensitiveColumnDetails¶

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

Bases: object

Details to create a new sensitive column in a sensitive data model.

Attributes

`OBJECT_TYPE_EDITIONING_VIEW`	A constant which can be used with the object_type property of a CreateSensitiveColumnDetails.
`OBJECT_TYPE_TABLE`	A constant which can be used with the object_type property of a CreateSensitiveColumnDetails.
`RELATION_TYPE_APP_DEFINED`	A constant which can be used with the relation_type property of a CreateSensitiveColumnDetails.
`RELATION_TYPE_DB_DEFINED`	A constant which can be used with the relation_type property of a CreateSensitiveColumnDetails.
`RELATION_TYPE_NONE`	A constant which can be used with the relation_type property of a CreateSensitiveColumnDetails.
`STATUS_INVALID`	A constant which can be used with the status property of a CreateSensitiveColumnDetails.
`STATUS_VALID`	A constant which can be used with the status property of a CreateSensitiveColumnDetails.
`app_defined_child_column_keys`	Gets the app_defined_child_column_keys of this CreateSensitiveColumnDetails.
`app_name`	Gets the app_name of this CreateSensitiveColumnDetails.
`column_name`	[Required] Gets the column_name of this CreateSensitiveColumnDetails.
`data_type`	Gets the data_type of this CreateSensitiveColumnDetails.
`db_defined_child_column_keys`	Gets the db_defined_child_column_keys of this CreateSensitiveColumnDetails.
`object_name`	[Required] Gets the object_name of this CreateSensitiveColumnDetails.
`object_type`	Gets the object_type of this CreateSensitiveColumnDetails.
`parent_column_keys`	Gets the parent_column_keys of this CreateSensitiveColumnDetails.
`relation_type`	Gets the relation_type of this CreateSensitiveColumnDetails.
`schema_name`	[Required] Gets the schema_name of this CreateSensitiveColumnDetails.
`sensitive_type_id`	Gets the sensitive_type_id of this CreateSensitiveColumnDetails.
`status`	Gets the status of this CreateSensitiveColumnDetails.

Methods

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

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

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

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

__init__(**kwargs)¶

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

Parameters:

app_name (str) – The value to assign to the app_name property of this CreateSensitiveColumnDetails.
schema_name (str) – The value to assign to the schema_name property of this CreateSensitiveColumnDetails.
object_name (str) – The value to assign to the object_name property of this CreateSensitiveColumnDetails.
column_name (str) – The value to assign to the column_name property of this CreateSensitiveColumnDetails.
object_type (str) – The value to assign to the object_type property of this CreateSensitiveColumnDetails. Allowed values for this property are: “TABLE”, “EDITIONING_VIEW”
data_type (str) – The value to assign to the data_type property of this CreateSensitiveColumnDetails.
status (str) – The value to assign to the status property of this CreateSensitiveColumnDetails. Allowed values for this property are: “VALID”, “INVALID”
sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this CreateSensitiveColumnDetails.
parent_column_keys (list[str]) – The value to assign to the parent_column_keys property of this CreateSensitiveColumnDetails.
relation_type (str) – The value to assign to the relation_type property of this CreateSensitiveColumnDetails. Allowed values for this property are: “NONE”, “APP_DEFINED”, “DB_DEFINED”
app_defined_child_column_keys (list[str]) – The value to assign to the app_defined_child_column_keys property of this CreateSensitiveColumnDetails.
db_defined_child_column_keys (list[str]) – The value to assign to the db_defined_child_column_keys property of this CreateSensitiveColumnDetails.

app_defined_child_column_keys¶

Gets the app_defined_child_column_keys of this CreateSensitiveColumnDetails. Unique keys identifying the columns that are application-level (non-dictionary) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

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

app_name¶

Gets the app_name of this CreateSensitiveColumnDetails. 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. If this attribute is not provided, it’s automatically populated with the value provided for the schemaName attribute.

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

column_name¶

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

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

data_type¶

Gets the data_type of this CreateSensitiveColumnDetails. The data type of the sensitive column.

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

db_defined_child_column_keys¶

Gets the db_defined_child_column_keys of this CreateSensitiveColumnDetails. Unique keys identifying the columns that are database-level (dictionary-defined) children of the sensitive column. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the child columns must be added to the sensitive data model before their keys can be specified here. If this attribute is provided, the parentColumnKeys and relationType attributes of the child columns are automatically updated to reflect the relationship.

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

object_name¶

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

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

object_type¶

Gets the object_type of this CreateSensitiveColumnDetails. The type of the database object that contains the sensitive column.

Allowed values for this property are: “TABLE”, “EDITIONING_VIEW”

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

parent_column_keys¶

Gets the parent_column_keys of this CreateSensitiveColumnDetails. Unique keys identifying the columns that are parents of the sensitive column. At present, it accepts only one parent column key. This attribute can be used to establish relationship between columns in a sensitive data model. Note that the parent column must be added to the sensitive data model before its key can be specified here. If this attribute is provided, the appDefinedChildColumnKeys or dbDefinedChildColumnKeys attribute of the parent column is automatically updated to reflect the relationship.

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

relation_type¶

Gets the relation_type of this CreateSensitiveColumnDetails. 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”

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

schema_name¶

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

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

sensitive_type_id¶

Gets the sensitive_type_id of this CreateSensitiveColumnDetails. The OCID of the sensitive type to be associated with the sensitive column.

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

status¶

Gets the status of this CreateSensitiveColumnDetails. 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.

Allowed values for this property are: “VALID”, “INVALID”

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