MaskingFormat¶
- class oci.data_safe.models.MaskingFormat(**kwargs)¶
Bases:
objectA masking format defines the logic to mask data in a database column. The condition attribute defines the condition that must be true for applying the masking format. It enables you to do <a href=”https://docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html”>conditional masking</a> so that you can mask the column data values differently using different masking formats and the associated conditions. A masking format can have one or more format entries. A format entry can be a basic masking format such as Random Number, or it can be a library masking format.The combined output of all the format entries is used for masking. It provides the flexibility to define a masking format that can generate different parts of a data value separately and then combine them to get the final data value for masking.
Methods:
__init__(**kwargs)Initializes a new MaskingFormat object with values from keyword arguments.
Attributes:
Gets the condition of this MaskingFormat.
Gets the description of this MaskingFormat.
[Required] Gets the format_entries of this MaskingFormat.
- __init__(**kwargs)¶
Initializes a new MaskingFormat object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
condition (str) – The value to assign to the condition property of this MaskingFormat.
description (str) – The value to assign to the description property of this MaskingFormat.
format_entries (list[oci.data_safe.models.FormatEntry]) – The value to assign to the format_entries property of this MaskingFormat.
- property condition¶
Gets the condition of this MaskingFormat. A condition that must be true for applying the masking format. It can be any valid SQL construct that can be used in a SQL predicate. It enables you to do <a href=”https://docs.oracle.com/en/cloud/paas/data-safe/udscs/conditional-masking.html”>conditional masking</a> so that you can mask the column data values differently using different masking formats and the associated conditions.
- Returns
The condition of this MaskingFormat.
- Return type
str
- property description¶
Gets the description of this MaskingFormat. The description of the masking format.
- Returns
The description of this MaskingFormat.
- Return type
str
- property format_entries¶
[Required] Gets the format_entries of this MaskingFormat. An array of format entries. The combined output of all the format entries is used for masking the column data values.
- Returns
The format_entries of this MaskingFormat.
- Return type