MaskedColumnSummary

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

Bases: object

Summary of a masked column. A masked column is a database column masked by a data masking request.

Attributes:

OBJECT_TYPE_EDITIONING_VIEW

A constant which can be used with the object_type property of a MaskedColumnSummary.

OBJECT_TYPE_TABLE

A constant which can be used with the object_type property of a MaskedColumnSummary.

column_name

[Required] Gets the column_name of this MaskedColumnSummary.

key

[Required] Gets the key of this MaskedColumnSummary.

masking_column_group

Gets the masking_column_group of this MaskedColumnSummary.

masking_format_used

[Required] Gets the masking_format_used of this MaskedColumnSummary.

object_name

[Required] Gets the object_name of this MaskedColumnSummary.

object_type

[Required] Gets the object_type of this MaskedColumnSummary.

parent_column_key

Gets the parent_column_key of this MaskedColumnSummary.

schema_name

[Required] Gets the schema_name of this MaskedColumnSummary.

sensitive_type_id

Gets the sensitive_type_id of this MaskedColumnSummary.

total_masked_values

[Required] Gets the total_masked_values of this MaskedColumnSummary.

Methods:

__init__(**kwargs)

Initializes a new MaskedColumnSummary 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 MaskedColumnSummary. 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 MaskedColumnSummary. This constant has a value of “TABLE”

__init__(**kwargs)

Initializes a new MaskedColumnSummary 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 MaskedColumnSummary.

  • parent_column_key (str) – The value to assign to the parent_column_key property of this MaskedColumnSummary.

  • sensitive_type_id (str) – The value to assign to the sensitive_type_id property of this MaskedColumnSummary.

  • schema_name (str) – The value to assign to the schema_name property of this MaskedColumnSummary.

  • object_name (str) – The value to assign to the object_name property of this MaskedColumnSummary.

  • object_type (str) – The value to assign to the object_type property of this MaskedColumnSummary. 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 MaskedColumnSummary.

  • masking_column_group (str) – The value to assign to the masking_column_group property of this MaskedColumnSummary.

  • masking_format_used (str) – The value to assign to the masking_format_used property of this MaskedColumnSummary.

  • total_masked_values (int) – The value to assign to the total_masked_values property of this MaskedColumnSummary.

property column_name

[Required] Gets the column_name of this MaskedColumnSummary. The name of the masked column.

Returns

The column_name of this MaskedColumnSummary.

Return type

str

property key

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

Returns

The key of this MaskedColumnSummary.

Return type

str

property masking_column_group

Gets the masking_column_group of this MaskedColumnSummary. The masking group of the masked column.

Returns

The masking_column_group of this MaskedColumnSummary.

Return type

str

property masking_format_used

[Required] Gets the masking_format_used of this MaskedColumnSummary. The masking format used for masking the column.

Returns

The masking_format_used of this MaskedColumnSummary.

Return type

str

property object_name

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

Returns

The object_name of this MaskedColumnSummary.

Return type

str

property object_type

[Required] Gets the object_type of this MaskedColumnSummary. The type of the object (table or editioning view) that contains the masked 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 MaskedColumnSummary.

Return type

str

property parent_column_key

Gets the parent_column_key of this MaskedColumnSummary. The unique key that identifies the parent column of the masked column.

Returns

The parent_column_key of this MaskedColumnSummary.

Return type

str

property schema_name

[Required] Gets the schema_name of this MaskedColumnSummary. The name of the schema that contains the masked column.

Returns

The schema_name of this MaskedColumnSummary.

Return type

str

property sensitive_type_id

Gets the sensitive_type_id of this MaskedColumnSummary. The OCID of the sensitive type associated with the masked column.

Returns

The sensitive_type_id of this MaskedColumnSummary.

Return type

str

property total_masked_values

[Required] Gets the total_masked_values of this MaskedColumnSummary. The total number of values masked in the column.

Returns

The total_masked_values of this MaskedColumnSummary.

Return type

int