CreateMaskingColumnDetails

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

Bases: object

Details to create a new masking column. You can use this to add a parent column only. It automatically adds the child columns from the associated sensitive data model or target database. If you provide the sensitiveTypeId attribute but not the maskingFormats attribute, it automatically assigns the default masking format associated with the specified sensitive type. Alternatively, if you provide the maskingFormats attribute, the specified masking formats are assigned to the column.

Using the maskingFormats attribute, you can assign one or more masking formats to a 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.

You can use the maskingColumnGroup attribute to group the columns that you would like to mask together. It enables you to do <a href=”https://docs.oracle.com/en/cloud/paas/data-safe/udscs/group-masking1.html#GUID-755056B9-9540-48C0-9491-262A44A85037”>group or compound masking</a> that ensures that the masked data across the columns in a group continue to retain the same logical relationship.

Attributes

OBJECT_TYPE_EDITIONING_VIEW A constant which can be used with the object_type property of a CreateMaskingColumnDetails.
OBJECT_TYPE_TABLE A constant which can be used with the object_type property of a CreateMaskingColumnDetails.
column_name [Required] Gets the column_name of this CreateMaskingColumnDetails.
is_masking_enabled Gets the is_masking_enabled of this CreateMaskingColumnDetails.
masking_column_group Gets the masking_column_group of this CreateMaskingColumnDetails.
masking_formats Gets the masking_formats of this CreateMaskingColumnDetails.
object_name [Required] Gets the object_name of this CreateMaskingColumnDetails.
object_type Gets the object_type of this CreateMaskingColumnDetails.
schema_name [Required] Gets the schema_name of this CreateMaskingColumnDetails.
sensitive_type_id Gets the sensitive_type_id of this CreateMaskingColumnDetails.

Methods

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

__init__(**kwargs)

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

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

[Required] Gets the column_name of this CreateMaskingColumnDetails. The name of the database column. This attribute cannot be updated for an existing

masking 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 CreateMaskingColumnDetails.
Return type:str
is_masking_enabled

Gets the is_masking_enabled of this CreateMaskingColumnDetails. Indicates if 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 CreateMaskingColumnDetails.
Return type:bool
masking_column_group

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

Gets the masking_formats of this CreateMaskingColumnDetails. 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 CreateMaskingColumnDetails.
Return type:list[oci.data_safe.models.MaskingFormat]
object_name

[Required] Gets the object_name of this CreateMaskingColumnDetails. The name of the object (table or editioning view) that contains the database column. This attribute cannot be updated for an existing masking column.

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

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

[Required] Gets the schema_name of this CreateMaskingColumnDetails. The name of the schema that contains the database column. This attribute cannot be updated for an existing masking column.

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

Gets the sensitive_type_id of this CreateMaskingColumnDetails. The OCID of the sensitive type to be associated with the masking column. Note that if the maskingFormats attribute isn’t provided while creating a masking column, the default masking format associated with the specified sensitive type is assigned to the masking column.

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