DeterministicSubstitutionFormatEntry¶

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

Bases: oci.data_safe.models.format_entry.FormatEntry

The Deterministic Substitution masking format uses the specified substitution column as the source of masked values. It performs hash-based substitution to replace the original data in a column with values from the substitution column. As a masking operation renames tables temporarily, the substitution column must be in a table that has no masking column. Also, you may want to ensure that the substitution column has sufficient values to uniquely mask the target column.

Deterministic Substitution requires a seed value while submitting a masking work request. Passing the same seed value when masking multiple times or masking different databases ensures that the data is masked deterministically. To learn more, check Deterministic Substitution in the Data Safe documentation.

Attributes

`TYPE_DELETE_ROWS`	str(object=’’) -> str
`TYPE_DETERMINISTIC_ENCRYPTION`	str(object=’’) -> str
`TYPE_DETERMINISTIC_ENCRYPTION_DATE`	str(object=’’) -> str
`TYPE_DETERMINISTIC_SUBSTITUTION`	str(object=’’) -> str
`TYPE_FIXED_NUMBER`	str(object=’’) -> str
`TYPE_FIXED_STRING`	str(object=’’) -> str
`TYPE_LIBRARY_MASKING_FORMAT`	str(object=’’) -> str
`TYPE_NULL_VALUE`	str(object=’’) -> str
`TYPE_PATTERN`	str(object=’’) -> str
`TYPE_POST_PROCESSING_FUNCTION`	str(object=’’) -> str
`TYPE_PRESERVE_ORIGINAL_DATA`	str(object=’’) -> str
`TYPE_RANDOM_DATE`	str(object=’’) -> str
`TYPE_RANDOM_DECIMAL_NUMBER`	str(object=’’) -> str
`TYPE_RANDOM_DIGITS`	str(object=’’) -> str
`TYPE_RANDOM_LIST`	str(object=’’) -> str
`TYPE_RANDOM_NUMBER`	str(object=’’) -> str
`TYPE_RANDOM_STRING`	str(object=’’) -> str
`TYPE_RANDOM_SUBSTITUTION`	str(object=’’) -> str
`TYPE_REGULAR_EXPRESSION`	str(object=’’) -> str
`TYPE_SHUFFLE`	str(object=’’) -> str
`TYPE_SQL_EXPRESSION`	str(object=’’) -> str
`TYPE_SUBSTRING`	str(object=’’) -> str
`TYPE_TRUNCATE_TABLE`	str(object=’’) -> str
`TYPE_USER_DEFINED_FUNCTION`	str(object=’’) -> str
`column_name`	[Required] Gets the column_name of this DeterministicSubstitutionFormatEntry.
`description`	Gets the description of this FormatEntry.
`schema_name`	[Required] Gets the schema_name of this DeterministicSubstitutionFormatEntry.
`table_name`	[Required] Gets the table_name of this DeterministicSubstitutionFormatEntry.
`type`	[Required] Gets the type of this FormatEntry.

Methods

`__init__`(**kwargs)	Initializes a new DeterministicSubstitutionFormatEntry object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

TYPE_DELETE_ROWS = 'DELETE_ROWS'¶

TYPE_DETERMINISTIC_ENCRYPTION = 'DETERMINISTIC_ENCRYPTION'¶

TYPE_DETERMINISTIC_ENCRYPTION_DATE = 'DETERMINISTIC_ENCRYPTION_DATE'¶

TYPE_DETERMINISTIC_SUBSTITUTION = 'DETERMINISTIC_SUBSTITUTION'¶

TYPE_FIXED_NUMBER = 'FIXED_NUMBER'¶

TYPE_FIXED_STRING = 'FIXED_STRING'¶

TYPE_LIBRARY_MASKING_FORMAT = 'LIBRARY_MASKING_FORMAT'¶

TYPE_NULL_VALUE = 'NULL_VALUE'¶

TYPE_PATTERN = 'PATTERN'¶

TYPE_POST_PROCESSING_FUNCTION = 'POST_PROCESSING_FUNCTION'¶

TYPE_PRESERVE_ORIGINAL_DATA = 'PRESERVE_ORIGINAL_DATA'¶

TYPE_RANDOM_DATE = 'RANDOM_DATE'¶

TYPE_RANDOM_DECIMAL_NUMBER = 'RANDOM_DECIMAL_NUMBER'¶

TYPE_RANDOM_DIGITS = 'RANDOM_DIGITS'¶

TYPE_RANDOM_LIST = 'RANDOM_LIST'¶

TYPE_RANDOM_NUMBER = 'RANDOM_NUMBER'¶

TYPE_RANDOM_STRING = 'RANDOM_STRING'¶

TYPE_RANDOM_SUBSTITUTION = 'RANDOM_SUBSTITUTION'¶

TYPE_REGULAR_EXPRESSION = 'REGULAR_EXPRESSION'¶

TYPE_SHUFFLE = 'SHUFFLE'¶

TYPE_SQL_EXPRESSION = 'SQL_EXPRESSION'¶

TYPE_SUBSTRING = 'SUBSTRING'¶

TYPE_TRUNCATE_TABLE = 'TRUNCATE_TABLE'¶

TYPE_USER_DEFINED_FUNCTION = 'USER_DEFINED_FUNCTION'¶

__init__(**kwargs)¶

Initializes a new DeterministicSubstitutionFormatEntry object with values from keyword arguments. The default value of the type attribute of this class is DETERMINISTIC_SUBSTITUTION and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

type (str) – The value to assign to the type property of this DeterministicSubstitutionFormatEntry. Allowed values for this property are: “DELETE_ROWS”, “DETERMINISTIC_SUBSTITUTION”, “DETERMINISTIC_ENCRYPTION”, “DETERMINISTIC_ENCRYPTION_DATE”, “FIXED_NUMBER”, “FIXED_STRING”, “LIBRARY_MASKING_FORMAT”, “NULL_VALUE”, “PATTERN”, “POST_PROCESSING_FUNCTION”, “PRESERVE_ORIGINAL_DATA”, “RANDOM_DATE”, “RANDOM_DECIMAL_NUMBER”, “RANDOM_DIGITS”, “RANDOM_LIST”, “RANDOM_NUMBER”, “RANDOM_STRING”, “RANDOM_SUBSTITUTION”, “REGULAR_EXPRESSION”, “SHUFFLE”, “SQL_EXPRESSION”, “SUBSTRING”, “TRUNCATE_TABLE”, “USER_DEFINED_FUNCTION”
description (str) – The value to assign to the description property of this DeterministicSubstitutionFormatEntry.
schema_name (str) – The value to assign to the schema_name property of this DeterministicSubstitutionFormatEntry.
table_name (str) – The value to assign to the table_name property of this DeterministicSubstitutionFormatEntry.
column_name (str) – The value to assign to the column_name property of this DeterministicSubstitutionFormatEntry.

column_name¶

[Required] Gets the column_name of this DeterministicSubstitutionFormatEntry. The name of the substitution column.

Returns:	The column_name of this DeterministicSubstitutionFormatEntry.
Return type:	str

description¶

Gets the description of this FormatEntry. The description of the format entry.

Returns:	The description of this FormatEntry.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

schema_name¶

[Required] Gets the schema_name of this DeterministicSubstitutionFormatEntry. The name of the schema that contains the substitution column.

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

table_name¶

[Required] Gets the table_name of this DeterministicSubstitutionFormatEntry. The name of the table that contains the substitution column.

Returns:	The table_name of this DeterministicSubstitutionFormatEntry.
Return type:	str

type¶

[Required] Gets the type of this FormatEntry. The type of the format entry.

Allowed values for this property are: “DELETE_ROWS”, “DETERMINISTIC_SUBSTITUTION”, “DETERMINISTIC_ENCRYPTION”, “DETERMINISTIC_ENCRYPTION_DATE”, “FIXED_NUMBER”, “FIXED_STRING”, “LIBRARY_MASKING_FORMAT”, “NULL_VALUE”, “PATTERN”, “POST_PROCESSING_FUNCTION”, “PRESERVE_ORIGINAL_DATA”, “RANDOM_DATE”, “RANDOM_DECIMAL_NUMBER”, “RANDOM_DIGITS”, “RANDOM_LIST”, “RANDOM_NUMBER”, “RANDOM_STRING”, “RANDOM_SUBSTITUTION”, “REGULAR_EXPRESSION”, “SHUFFLE”, “SQL_EXPRESSION”, “SUBSTRING”, “TRUNCATE_TABLE”, “USER_DEFINED_FUNCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The type of this FormatEntry.
Return type:	str