CreateLibraryMaskingFormatDetails¶

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

Bases: object

Details to create a library masking format, which 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. Note that you cannot define masking condition in a library masking format.

Methods

__init__(**kwargs) Initializes a new CreateLibraryMaskingFormatDetails object with values from keyword arguments.

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateLibraryMaskingFormatDetails.
`defined_tags`	Gets the defined_tags of this CreateLibraryMaskingFormatDetails.
`description`	Gets the description of this CreateLibraryMaskingFormatDetails.
`display_name`	Gets the display_name of this CreateLibraryMaskingFormatDetails.
`format_entries`	[Required] Gets the format_entries of this CreateLibraryMaskingFormatDetails.
`freeform_tags`	Gets the freeform_tags of this CreateLibraryMaskingFormatDetails.
`sensitive_type_ids`	Gets the sensitive_type_ids of this CreateLibraryMaskingFormatDetails.

__init__(**kwargs)¶

Initializes a new CreateLibraryMaskingFormatDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateLibraryMaskingFormatDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateLibraryMaskingFormatDetails.
description (str) – The value to assign to the description property of this CreateLibraryMaskingFormatDetails.
sensitive_type_ids (list[str]) – The value to assign to the sensitive_type_ids property of this CreateLibraryMaskingFormatDetails.
format_entries (list[oci.data_safe.models.FormatEntry]) – The value to assign to the format_entries property of this CreateLibraryMaskingFormatDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateLibraryMaskingFormatDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateLibraryMaskingFormatDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateLibraryMaskingFormatDetails. The OCID of the compartment where the library masking format should be created.

Returns:	The compartment_id of this CreateLibraryMaskingFormatDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateLibraryMaskingFormatDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this CreateLibraryMaskingFormatDetails.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this CreateLibraryMaskingFormatDetails. The description of the library masking format.

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

display_name¶

Gets the display_name of this CreateLibraryMaskingFormatDetails. The display name of the library masking format. The name does not have to be unique, and it’s changeable.

Returns:	The display_name of this CreateLibraryMaskingFormatDetails.
Return type:	str

format_entries¶

[Required] Gets the format_entries of this CreateLibraryMaskingFormatDetails. An array of format entries. The combined output of all the format entries is used for masking.

Returns:	The format_entries of this CreateLibraryMaskingFormatDetails.
Return type:	list[oci.data_safe.models.FormatEntry]

freeform_tags¶

Gets the freeform_tags of this CreateLibraryMaskingFormatDetails. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this CreateLibraryMaskingFormatDetails.
Return type:	dict(str, str)

sensitive_type_ids¶

Gets the sensitive_type_ids of this CreateLibraryMaskingFormatDetails. An array of OCIDs of the sensitive types compatible with the library masking format. It helps track the sensitive types for which the library masking format is being created.

Returns:	The sensitive_type_ids of this CreateLibraryMaskingFormatDetails.
Return type:	list[str]