DeterministicEncryptionDateFormatEntry¶

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

Bases: oci.data_safe.models.format_entry.FormatEntry

The Deterministic Encryption (Date) masking format encrypts column data using a cryptographic key and Advanced Encryption Standard (AES 128). It can be used to encrypt date columns only. It requires a range of dates as input defined by the startDate and endDate attributes. The start date must be less than or equal to the end date.

The original column values in all the rows must be within the specified date range. The encrypted values are also within the specified range. Therefore, to ensure uniqueness, the total number of dates in the range must be greater than or equal to the number of distinct original values in the column. If an original value is not in the specified date range, it might not produce a one-to-one mapping. All non-confirming values are mapped to a single encrypted value, thereby producing a many-to-one mapping.

Deterministic Encryption (Date) is a format-preserving, deterministic and reversible masking format, which 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 Encryption 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
`description`	Gets the description of this FormatEntry.
`end_date`	[Required] Gets the end_date of this DeterministicEncryptionDateFormatEntry.
`start_date`	[Required] Gets the start_date of this DeterministicEncryptionDateFormatEntry.
`type`	[Required] Gets the type of this FormatEntry.

Methods

`__init__`(**kwargs)	Initializes a new DeterministicEncryptionDateFormatEntry 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 DeterministicEncryptionDateFormatEntry object with values from keyword arguments. The default value of the type attribute of this class is DETERMINISTIC_ENCRYPTION_DATE 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 DeterministicEncryptionDateFormatEntry. 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 DeterministicEncryptionDateFormatEntry.
start_date (datetime) – The value to assign to the start_date property of this DeterministicEncryptionDateFormatEntry.
end_date (datetime) – The value to assign to the end_date property of this DeterministicEncryptionDateFormatEntry.

description¶

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

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

end_date¶

[Required] Gets the end_date of this DeterministicEncryptionDateFormatEntry. The upper bound of the range within which all the original column values fall. The end date must be greater than or equal to the start date.

Returns:	The end_date of this DeterministicEncryptionDateFormatEntry.
Return type:	datetime

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.

start_date¶

[Required] Gets the start_date of this DeterministicEncryptionDateFormatEntry. The lower bound of the range within which all the original column values fall. The start date must be less than or equal to the end date.

Returns:	The start_date of this DeterministicEncryptionDateFormatEntry.
Return type:	datetime

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