LibraryMaskingFormat¶

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

Bases: object

A library masking format is a masking format stored in an Oracle Cloud Infrastructure compartment and can be used in multiple masking policies. If you want to use the same masking logic for multiple masking columns or even in multiple masking policies, you can create a library masking format and assign it to masking columns as needed. It helps you avoid defining the same masking logic again and again.

Oracle Data Safe provides a set of predefined library masking formats to mask common sensitive and personal data, such as names, national identifiers, credit card numbers, and phone numbers. To meet your specific requirements, you can easily create new library masking formats and use them in your masking policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat.
`SOURCE_ORACLE`	A constant which can be used with the source property of a LibraryMaskingFormat.
`SOURCE_USER`	A constant which can be used with the source property of a LibraryMaskingFormat.
`compartment_id`	[Required] Gets the compartment_id of this LibraryMaskingFormat.
`defined_tags`	Gets the defined_tags of this LibraryMaskingFormat.
`description`	Gets the description of this LibraryMaskingFormat.
`display_name`	[Required] Gets the display_name of this LibraryMaskingFormat.
`format_entries`	Gets the format_entries of this LibraryMaskingFormat.
`freeform_tags`	Gets the freeform_tags of this LibraryMaskingFormat.
`id`	[Required] Gets the id of this LibraryMaskingFormat.
`lifecycle_state`	[Required] Gets the lifecycle_state of this LibraryMaskingFormat.
`sensitive_type_ids`	Gets the sensitive_type_ids of this LibraryMaskingFormat.
`source`	[Required] Gets the source of this LibraryMaskingFormat.
`time_created`	[Required] Gets the time_created of this LibraryMaskingFormat.
`time_updated`	[Required] Gets the time_updated of this LibraryMaskingFormat.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “FAILED”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a LibraryMaskingFormat. This constant has a value of “UPDATING”

SOURCE_ORACLE = 'ORACLE'¶: A constant which can be used with the source property of a LibraryMaskingFormat. This constant has a value of “ORACLE”

SOURCE_USER = 'USER'¶: A constant which can be used with the source property of a LibraryMaskingFormat. This constant has a value of “USER”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this LibraryMaskingFormat.
compartment_id (str) – The value to assign to the compartment_id property of this LibraryMaskingFormat.
display_name (str) – The value to assign to the display_name property of this LibraryMaskingFormat.
time_created (datetime) – The value to assign to the time_created property of this LibraryMaskingFormat.
time_updated (datetime) – The value to assign to the time_updated property of this LibraryMaskingFormat.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this LibraryMaskingFormat. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
description (str) – The value to assign to the description property of this LibraryMaskingFormat.
sensitive_type_ids (list[str]) – The value to assign to the sensitive_type_ids property of this LibraryMaskingFormat.
source (str) – The value to assign to the source property of this LibraryMaskingFormat. Allowed values for this property are: “ORACLE”, “USER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
format_entries (list[oci.data_safe.models.FormatEntry]) – The value to assign to the format_entries property of this LibraryMaskingFormat.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this LibraryMaskingFormat.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this LibraryMaskingFormat.

compartment_id¶

[Required] Gets the compartment_id of this LibraryMaskingFormat. The OCID of the compartment that contains the library masking format.

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

defined_tags¶

Gets the defined_tags of this LibraryMaskingFormat. 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 LibraryMaskingFormat.
Return type:	dict(str, dict(str, object))

description¶

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

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

display_name¶

[Required] Gets the display_name of this LibraryMaskingFormat. The display name of the library masking format.

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

format_entries¶

Gets the format_entries of this LibraryMaskingFormat. An array of format entries. The combined output of all the format entries is used for masking.

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

freeform_tags¶

Gets the freeform_tags of this LibraryMaskingFormat. 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 LibraryMaskingFormat.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this LibraryMaskingFormat. The OCID of the library masking format.

Returns:	The id of this LibraryMaskingFormat.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this LibraryMaskingFormat. The current state of the library masking format.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “NEEDS_ATTENTION”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this LibraryMaskingFormat.
Return type:	str

sensitive_type_ids¶

Gets the sensitive_type_ids of this LibraryMaskingFormat. An array of OCIDs of the sensitive types compatible with the library masking format.

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

source¶

[Required] Gets the source of this LibraryMaskingFormat. Specifies whether the library masking format is user-defined or predefined.

Allowed values for this property are: “ORACLE”, “USER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The source of this LibraryMaskingFormat.
Return type:	str

time_created¶

[Required] Gets the time_created of this LibraryMaskingFormat. The date and time the library masking format was created, in the format defined by RFC3339

Returns:	The time_created of this LibraryMaskingFormat.
Return type:	datetime

time_updated¶

[Required] Gets the time_updated of this LibraryMaskingFormat. The date and time the library masking format was updated, in the format defined by RFC3339

Returns:	The time_updated of this LibraryMaskingFormat.
Return type:	datetime