RandomDigitsFormatEntry

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

Bases: FormatEntry

The Random Digits masking format generates random digits of length within a range. The length range is defined by the startLength and endLength attributes. The start length must be less than or equal to the end length. When masking columns with uniqueness constraint, ensure that the length range is sufficient enough to generate unique values. This masking format pads to the appropriate length in a string, but does not pad when used for a number column. It’s a complementary type of Random Number, which is not padded.

Attributes:

TYPE_DELETE_ROWS	A constant which can be used with the type property of a FormatEntry.
TYPE_DETERMINISTIC_ENCRYPTION	A constant which can be used with the type property of a FormatEntry.
TYPE_DETERMINISTIC_ENCRYPTION_DATE	A constant which can be used with the type property of a FormatEntry.
TYPE_DETERMINISTIC_SUBSTITUTION	A constant which can be used with the type property of a FormatEntry.
TYPE_FIXED_NUMBER	A constant which can be used with the type property of a FormatEntry.
TYPE_FIXED_STRING	A constant which can be used with the type property of a FormatEntry.
TYPE_LIBRARY_MASKING_FORMAT	A constant which can be used with the type property of a FormatEntry.
TYPE_NULL_VALUE	A constant which can be used with the type property of a FormatEntry.
TYPE_PATTERN	A constant which can be used with the type property of a FormatEntry.
TYPE_POST_PROCESSING_FUNCTION	A constant which can be used with the type property of a FormatEntry.
TYPE_PRESERVE_ORIGINAL_DATA	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_DATE	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_DECIMAL_NUMBER	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_DIGITS	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_LIST	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_NUMBER	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_STRING	A constant which can be used with the type property of a FormatEntry.
TYPE_RANDOM_SUBSTITUTION	A constant which can be used with the type property of a FormatEntry.
TYPE_REGULAR_EXPRESSION	A constant which can be used with the type property of a FormatEntry.
TYPE_SHUFFLE	A constant which can be used with the type property of a FormatEntry.
TYPE_SQL_EXPRESSION	A constant which can be used with the type property of a FormatEntry.
TYPE_SUBSTRING	A constant which can be used with the type property of a FormatEntry.
TYPE_TRUNCATE_TABLE	A constant which can be used with the type property of a FormatEntry.
TYPE_USER_DEFINED_FUNCTION	A constant which can be used with the type property of a FormatEntry.
description	Gets the description of this FormatEntry.
end_length	[Required] Gets the end_length of this RandomDigitsFormatEntry.
start_length	[Required] Gets the start_length of this RandomDigitsFormatEntry.
type	[Required] Gets the type of this FormatEntry.

Methods:

__init__(**kwargs)	Initializes a new RandomDigitsFormatEntry 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'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “DELETE_ROWS”

TYPE_DETERMINISTIC_ENCRYPTION = 'DETERMINISTIC_ENCRYPTION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “DETERMINISTIC_ENCRYPTION”

TYPE_DETERMINISTIC_ENCRYPTION_DATE = 'DETERMINISTIC_ENCRYPTION_DATE'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “DETERMINISTIC_ENCRYPTION_DATE”

TYPE_DETERMINISTIC_SUBSTITUTION = 'DETERMINISTIC_SUBSTITUTION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “DETERMINISTIC_SUBSTITUTION”

TYPE_FIXED_NUMBER = 'FIXED_NUMBER'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “FIXED_NUMBER”

TYPE_FIXED_STRING = 'FIXED_STRING'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “FIXED_STRING”

TYPE_LIBRARY_MASKING_FORMAT = 'LIBRARY_MASKING_FORMAT'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “LIBRARY_MASKING_FORMAT”

TYPE_NULL_VALUE = 'NULL_VALUE'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “NULL_VALUE”

TYPE_PATTERN = 'PATTERN'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “PATTERN”

TYPE_POST_PROCESSING_FUNCTION = 'POST_PROCESSING_FUNCTION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “POST_PROCESSING_FUNCTION”

TYPE_PRESERVE_ORIGINAL_DATA = 'PRESERVE_ORIGINAL_DATA'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “PRESERVE_ORIGINAL_DATA”

TYPE_RANDOM_DATE = 'RANDOM_DATE'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_DATE”

TYPE_RANDOM_DECIMAL_NUMBER = 'RANDOM_DECIMAL_NUMBER'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_DECIMAL_NUMBER”

TYPE_RANDOM_DIGITS = 'RANDOM_DIGITS'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_DIGITS”

TYPE_RANDOM_LIST = 'RANDOM_LIST'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_LIST”

TYPE_RANDOM_NUMBER = 'RANDOM_NUMBER'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_NUMBER”

TYPE_RANDOM_STRING = 'RANDOM_STRING'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_STRING”

TYPE_RANDOM_SUBSTITUTION = 'RANDOM_SUBSTITUTION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “RANDOM_SUBSTITUTION”

TYPE_REGULAR_EXPRESSION = 'REGULAR_EXPRESSION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “REGULAR_EXPRESSION”

TYPE_SHUFFLE = 'SHUFFLE'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “SHUFFLE”

TYPE_SQL_EXPRESSION = 'SQL_EXPRESSION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “SQL_EXPRESSION”

TYPE_SUBSTRING = 'SUBSTRING'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “SUBSTRING”

TYPE_TRUNCATE_TABLE = 'TRUNCATE_TABLE'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “TRUNCATE_TABLE”

TYPE_USER_DEFINED_FUNCTION = 'USER_DEFINED_FUNCTION'

A constant which can be used with the type property of a FormatEntry. This constant has a value of “USER_DEFINED_FUNCTION”

__init__(**kwargs)

Initializes a new RandomDigitsFormatEntry object with values from keyword arguments. The default value of the type attribute of this class is RANDOM_DIGITS 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 RandomDigitsFormatEntry. 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 RandomDigitsFormatEntry.

• start_length (int) – The value to assign to the start_length property of this RandomDigitsFormatEntry.

• end_length (int) – The value to assign to the end_length property of this RandomDigitsFormatEntry.

property description

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

Returns

The description of this FormatEntry.

Return type

str

property end_length

[Required] Gets the end_length of this RandomDigitsFormatEntry. The maximum number of digits the generated values should have. It can be any integer greater than zero, but it must be greater than or equal to the start length.

Returns

The end_length of this RandomDigitsFormatEntry.

Return type

int

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.

property start_length

[Required] Gets the start_length of this RandomDigitsFormatEntry. The minimum number of digits the generated values should have. It can be any integer greater than zero, but it must be less than or equal to the end length.

Returns

The start_length of this RandomDigitsFormatEntry.

Return type

int

property 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