MaskingColumnSummary¶

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

Bases: object

Summary of a masking column.

Attributes

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

Methods

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

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

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

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

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a MaskingColumnSummary. 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 MaskingColumnSummary. 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 MaskingColumnSummary. 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 MaskingColumnSummary. 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 MaskingColumnSummary. This constant has a value of “TABLE”

__init__(**kwargs)¶

Initializes a new MaskingColumnSummary 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 MaskingColumnSummary.
masking_policy_id (str) – The value to assign to the masking_policy_id property of this MaskingColumnSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this MaskingColumnSummary. 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 MaskingColumnSummary.
time_created (datetime) – The value to assign to the time_created property of this MaskingColumnSummary.
time_updated (datetime) – The value to assign to the time_updated property of this MaskingColumnSummary.
schema_name (str) – The value to assign to the schema_name property of this MaskingColumnSummary.
object_name (str) – The value to assign to the object_name property of this MaskingColumnSummary.
object_type (str) – The value to assign to the object_type property of this MaskingColumnSummary. 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 MaskingColumnSummary.
child_columns (list[str]) – The value to assign to the child_columns property of this MaskingColumnSummary.
masking_column_group (str) – The value to assign to the masking_column_group property of this MaskingColumnSummary.
sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this MaskingColumnSummary.
is_masking_enabled (bool) – The value to assign to the is_masking_enabled property of this MaskingColumnSummary.
data_type (str) – The value to assign to the data_type property of this MaskingColumnSummary.
masking_formats (list[oci.data_safe.models.MaskingFormat]) – The value to assign to the masking_formats property of this MaskingColumnSummary.

child_columns¶

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

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

column_name¶

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

data_type¶

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

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

is_masking_enabled¶

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

Returns:	The is_masking_enabled of this MaskingColumnSummary.
Return type:	bool

key¶

[Required] Gets the key of this MaskingColumnSummary. The unique key that identifies a masking column. The key is numeric and unique within a masking policy.

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

lifecycle_details¶

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

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

lifecycle_state¶

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

masking_column_group¶

Gets the masking_column_group of this MaskingColumnSummary. 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 MaskingColumnSummary.
Return type:	str

masking_formats¶

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

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

masking_policy_id¶

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

Returns:	The masking_policy_id of this MaskingColumnSummary.
Return type:	str

object_name¶

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

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

object_type¶

Gets the object_type of this MaskingColumnSummary. 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 MaskingColumnSummary.
Return type:	str

schema_name¶

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

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

sensitive_type_id¶

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

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

time_created¶

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

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

time_updated¶

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

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