ShuffleFormatEntry

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

Bases: oci.data_safe.models.format_entry.FormatEntry

The Shuffle masking format randomly shuffles values within a column. It can also be used to shuffle column data within discrete units, or groups, where there is a relationship among the members of each group. To learn more, check Shuffle in the Data Safe documentation. The Shuffle masking format randomly shuffles values within a column. It can also be used to shuffle column data within discrete units, or groups, where there is a relationship among the members of each group. To learn more, check Shuffle 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_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
description Gets the description of this FormatEntry.
grouping_columns Gets the grouping_columns of this ShuffleFormatEntry.
type [Required] Gets the type of this FormatEntry.

Methods

__init__(**kwargs) Initializes a new ShuffleFormatEntry 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_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 ShuffleFormatEntry object with values from keyword arguments. The default value of the type attribute of this class is SHUFFLE 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 ShuffleFormatEntry. Allowed values for this property are: “DELETE_ROWS”, “DETERMINISTIC_SUBSTITUTION”, “DETERMINISTIC_ENCRYPTION”, “DETERMINISTIC_ENCRYPTION_DATE”, “FIXED_NUMBER”, “FIXED_STRING”, “LIBRARY_MASKING_FORMAT”, “NULL_VALUE”, “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 ShuffleFormatEntry.
  • grouping_columns (list[str]) – The value to assign to the grouping_columns property of this ShuffleFormatEntry.
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.

grouping_columns

Gets the grouping_columns of this ShuffleFormatEntry. One or more reference columns to be used to group column values so that they can be shuffled within their own group. The grouping columns and the column to be masked must belong to the same table.

Returns:The grouping_columns of this ShuffleFormatEntry.
Return type:list[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”, “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