UpdateMaskingColumnDetails¶

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

Bases: object

Details to update a masking column.

Attributes

`OBJECT_TYPE_EDITIONING_VIEW`	A constant which can be used with the object_type property of a UpdateMaskingColumnDetails.
`OBJECT_TYPE_TABLE`	A constant which can be used with the object_type property of a UpdateMaskingColumnDetails.
`is_masking_enabled`	Gets the is_masking_enabled of this UpdateMaskingColumnDetails.
`masking_column_group`	Gets the masking_column_group of this UpdateMaskingColumnDetails.
`masking_formats`	Gets the masking_formats of this UpdateMaskingColumnDetails.
`object_type`	Gets the object_type of this UpdateMaskingColumnDetails.
`sensitive_type_id`	Gets the sensitive_type_id of this UpdateMaskingColumnDetails.

Methods

__init__(**kwargs) Initializes a new UpdateMaskingColumnDetails 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 UpdateMaskingColumnDetails. 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 UpdateMaskingColumnDetails. This constant has a value of “TABLE”

__init__(**kwargs)¶

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

Parameters:

object_type (str) – The value to assign to the object_type property of this UpdateMaskingColumnDetails. Allowed values for this property are: “TABLE”, “EDITIONING_VIEW”
masking_column_group (str) – The value to assign to the masking_column_group property of this UpdateMaskingColumnDetails.
sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this UpdateMaskingColumnDetails.
is_masking_enabled (bool) – The value to assign to the is_masking_enabled property of this UpdateMaskingColumnDetails.
masking_formats (list[oci.data_safe.models.MaskingFormat]) – The value to assign to the masking_formats property of this UpdateMaskingColumnDetails.

is_masking_enabled¶

Gets the is_masking_enabled of this UpdateMaskingColumnDetails. Indicates whether data masking is enabled for the masking column. Set it to false if you don’t want to mask the column.

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

masking_column_group¶

Gets the masking_column_group of this UpdateMaskingColumnDetails. The group of the masking column. It’s a masking group identifier and can be any string of acceptable length. 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 UpdateMaskingColumnDetails.
Return type:	str

masking_formats¶

Gets the masking_formats of this UpdateMaskingColumnDetails. The masking formats to be assigned to the masking column. You can specify a condition as part of each masking format. It enables you to do <a href=”https://docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html”>conditional masking</a> so that you can mask the column data values differently using different masking formats and the associated conditions. A masking format can have one or more format entries. The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.

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

object_type¶

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

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

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

sensitive_type_id¶

Gets the sensitive_type_id of this UpdateMaskingColumnDetails. The OCID of the sensitive type to be associated with the masking column. Note that there will be no change in assigned masking format when sensitive type is changed.

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