MaskingColumn

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

Bases: object

A masking column is a resource corresponding to a database column that you want to mask. It’s a subresource of masking policy resource and is always associated with a masking policy. Note that only parent columns are managed as masking columns. The child columns are automatically managed using the childColumns attribute.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a MaskingColumn.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a MaskingColumn.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a MaskingColumn.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a MaskingColumn.
LIFECYCLE_STATE_NEEDS_ATTENTION A constant which can be used with the lifecycle_state property of a MaskingColumn.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a MaskingColumn.
OBJECT_TYPE_EDITIONING_VIEW A constant which can be used with the object_type property of a MaskingColumn.
OBJECT_TYPE_TABLE A constant which can be used with the object_type property of a MaskingColumn.
child_columns Gets the child_columns of this MaskingColumn.
column_name [Required] Gets the column_name of this MaskingColumn.
data_type Gets the data_type of this MaskingColumn.
is_masking_enabled [Required] Gets the is_masking_enabled of this MaskingColumn.
key [Required] Gets the key of this MaskingColumn.
lifecycle_details Gets the lifecycle_details of this MaskingColumn.
lifecycle_state [Required] Gets the lifecycle_state of this MaskingColumn.
masking_column_group Gets the masking_column_group of this MaskingColumn.
masking_formats Gets the masking_formats of this MaskingColumn.
masking_policy_id [Required] Gets the masking_policy_id of this MaskingColumn.
object_name [Required] Gets the object_name of this MaskingColumn.
object_type Gets the object_type of this MaskingColumn.
schema_name [Required] Gets the schema_name of this MaskingColumn.
sensitive_type_id Gets the sensitive_type_id of this MaskingColumn.
time_created [Required] Gets the time_created of this MaskingColumn.
time_updated [Required] Gets the time_updated of this MaskingColumn.

Methods

__init__(**kwargs) Initializes a new MaskingColumn object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a MaskingColumn. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a MaskingColumn. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a MaskingColumn. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a MaskingColumn. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'

A constant which can be used with the lifecycle_state property of a MaskingColumn. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a MaskingColumn. 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 MaskingColumn. 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 MaskingColumn. This constant has a value of “TABLE”

__init__(**kwargs)

Initializes a new MaskingColumn 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 MaskingColumn.
  • masking_policy_id (str) – The value to assign to the masking_policy_id property of this MaskingColumn.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this MaskingColumn. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “NEEDS_ATTENTION”, “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 MaskingColumn.
  • time_created (datetime) – The value to assign to the time_created property of this MaskingColumn.
  • time_updated (datetime) – The value to assign to the time_updated property of this MaskingColumn.
  • schema_name (str) – The value to assign to the schema_name property of this MaskingColumn.
  • object_name (str) – The value to assign to the object_name property of this MaskingColumn.
  • object_type (str) – The value to assign to the object_type property of this MaskingColumn. 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’.
  • column_name (str) – The value to assign to the column_name property of this MaskingColumn.
  • child_columns (list[str]) – The value to assign to the child_columns property of this MaskingColumn.
  • masking_column_group (str) – The value to assign to the masking_column_group property of this MaskingColumn.
  • sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this MaskingColumn.
  • is_masking_enabled (bool) – The value to assign to the is_masking_enabled property of this MaskingColumn.
  • data_type (str) – The value to assign to the data_type property of this MaskingColumn.
  • masking_formats (list[oci.data_safe.models.MaskingFormat]) – The value to assign to the masking_formats property of this MaskingColumn.
child_columns

Gets the child_columns of this MaskingColumn. An array of child columns that are in referential relationship with the masking column.

Returns:The child_columns of this MaskingColumn.
Return type:list[str]
column_name

[Required] Gets the column_name of this MaskingColumn. The name of the database column. Note that the same name is used for the masking column. There is no separate displayName attribute for the masking column.

Returns:The column_name of this MaskingColumn.
Return type:str
data_type

Gets the data_type of this MaskingColumn. The data type of the masking column.

Returns:The data_type of this MaskingColumn.
Return type:str
is_masking_enabled

[Required] Gets the is_masking_enabled of this MaskingColumn. Indicates if data masking is enabled for the masking column.

Returns:The is_masking_enabled of this MaskingColumn.
Return type:bool
key

[Required] Gets the key of this MaskingColumn. The unique key that identifies the masking column. It’s numeric and unique within a masking policy.

Returns:The key of this MaskingColumn.
Return type:str
lifecycle_details

Gets the lifecycle_details of this MaskingColumn. Details about the current state of the masking column.

Returns:The lifecycle_details of this MaskingColumn.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this MaskingColumn. The current state of the masking column.

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

Returns:The lifecycle_state of this MaskingColumn.
Return type:str
masking_column_group

Gets the masking_column_group of this MaskingColumn. The group of the masking column. All the columns in a group are masked together to ensure that the masked data across these columns continue to retain the same logical relationship. For more details, check <a href=https://docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037>Group Masking in the Data Safe documentation.</a>

Returns:The masking_column_group of this MaskingColumn.
Return type:str
masking_formats

Gets the masking_formats of this MaskingColumn. An array of masking formats assigned to the masking column.

Returns:The masking_formats of this MaskingColumn.
Return type:list[oci.data_safe.models.MaskingFormat]
masking_policy_id

[Required] Gets the masking_policy_id of this MaskingColumn. The OCID of the masking policy that contains the masking column.

Returns:The masking_policy_id of this MaskingColumn.
Return type:str
object_name

[Required] Gets the object_name of this MaskingColumn. The name of the object (table or editioning view) that contains the database column.

Returns:The object_name of this MaskingColumn.
Return type:str
object_type

Gets the object_type of this MaskingColumn. The type of the object that contains the database 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 MaskingColumn.
Return type:str
schema_name

[Required] Gets the schema_name of this MaskingColumn. The name of the schema that contains the database column.

Returns:The schema_name of this MaskingColumn.
Return type:str
sensitive_type_id

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

Returns:The sensitive_type_id of this MaskingColumn.
Return type:str
time_created

[Required] Gets the time_created of this MaskingColumn. The date and time the masking column was created, in the format defined by RFC3339.

Returns:The time_created of this MaskingColumn.
Return type:datetime
time_updated

[Required] Gets the time_updated of this MaskingColumn. The date and time the masking column was last updated, in the format defined by RFC3339.

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