DataMaskRuleSummary

class oci.cloud_guard.models.DataMaskRuleSummary(**kwargs)

Bases: object

Summary information for a data mask rule.

Attributes:

DATA_MASK_CATEGORIES_ACTOR

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_CATEGORIES_CUSTOM

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_CATEGORIES_FINANCIAL

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_CATEGORIES_LOCATION

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_CATEGORIES_PHI

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_CATEGORIES_PII

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary.

DATA_MASK_RULE_STATUS_DISABLED

A constant which can be used with the data_mask_rule_status property of a DataMaskRuleSummary.

DATA_MASK_RULE_STATUS_ENABLED

A constant which can be used with the data_mask_rule_status property of a DataMaskRuleSummary.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary.

compartment_id

[Required] Gets the compartment_id of this DataMaskRuleSummary.

data_mask_categories

Gets the data_mask_categories of this DataMaskRuleSummary.

data_mask_rule_status

Gets the data_mask_rule_status of this DataMaskRuleSummary.

defined_tags

Gets the defined_tags of this DataMaskRuleSummary.

description

Gets the description of this DataMaskRuleSummary.

display_name

Gets the display_name of this DataMaskRuleSummary.

freeform_tags

Gets the freeform_tags of this DataMaskRuleSummary.

iam_group_id

[Required] Gets the iam_group_id of this DataMaskRuleSummary.

id

[Required] Gets the id of this DataMaskRuleSummary.

lifecycle_state

Gets the lifecycle_state of this DataMaskRuleSummary.

lifecyle_details

Gets the lifecyle_details of this DataMaskRuleSummary.

system_tags

Gets the system_tags of this DataMaskRuleSummary.

target_selected

[Required] Gets the target_selected of this DataMaskRuleSummary.

time_created

Gets the time_created of this DataMaskRuleSummary.

time_updated

Gets the time_updated of this DataMaskRuleSummary.

Methods:

__init__(**kwargs)

Initializes a new DataMaskRuleSummary object with values from keyword arguments.

DATA_MASK_CATEGORIES_ACTOR = 'ACTOR'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “ACTOR”

DATA_MASK_CATEGORIES_CUSTOM = 'CUSTOM'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “CUSTOM”

DATA_MASK_CATEGORIES_FINANCIAL = 'FINANCIAL'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “FINANCIAL”

DATA_MASK_CATEGORIES_LOCATION = 'LOCATION'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “LOCATION”

DATA_MASK_CATEGORIES_PHI = 'PHI'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “PHI”

DATA_MASK_CATEGORIES_PII = 'PII'

A constant which can be used with the data_mask_categories property of a DataMaskRuleSummary. This constant has a value of “PII”

DATA_MASK_RULE_STATUS_DISABLED = 'DISABLED'

A constant which can be used with the data_mask_rule_status property of a DataMaskRuleSummary. This constant has a value of “DISABLED”

DATA_MASK_RULE_STATUS_ENABLED = 'ENABLED'

A constant which can be used with the data_mask_rule_status property of a DataMaskRuleSummary. This constant has a value of “ENABLED”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a DataMaskRuleSummary. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new DataMaskRuleSummary 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 DataMaskRuleSummary.

  • display_name (str) – The value to assign to the display_name property of this DataMaskRuleSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this DataMaskRuleSummary.

  • description (str) – The value to assign to the description property of this DataMaskRuleSummary.

  • iam_group_id (str) – The value to assign to the iam_group_id property of this DataMaskRuleSummary.

  • target_selected (oci.cloud_guard.models.TargetSelected) – The value to assign to the target_selected property of this DataMaskRuleSummary.

  • data_mask_categories (list[str]) – The value to assign to the data_mask_categories property of this DataMaskRuleSummary. Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this DataMaskRuleSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this DataMaskRuleSummary.

  • data_mask_rule_status (str) – The value to assign to the data_mask_rule_status property of this DataMaskRuleSummary. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DataMaskRuleSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecyle_details (str) – The value to assign to the lifecyle_details property of this DataMaskRuleSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DataMaskRuleSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DataMaskRuleSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DataMaskRuleSummary.

property compartment_id

[Required] Gets the compartment_id of this DataMaskRuleSummary. Compartment OCID where the resource is created

Returns

The compartment_id of this DataMaskRuleSummary.

Return type

str

property data_mask_categories

Gets the data_mask_categories of this DataMaskRuleSummary. List of data mask rule categories

Allowed values for items in this list are: “ACTOR”, “PII”, “PHI”, “FINANCIAL”, “LOCATION”, “CUSTOM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The data_mask_categories of this DataMaskRuleSummary.

Return type

list[str]

property data_mask_rule_status

Gets the data_mask_rule_status of this DataMaskRuleSummary. The current status of the data mask rule

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

Returns

The data_mask_rule_status of this DataMaskRuleSummary.

Return type

str

property defined_tags

Gets the defined_tags of this DataMaskRuleSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this DataMaskRuleSummary.

Return type

dict(str, dict(str, object))

property description

Gets the description of this DataMaskRuleSummary. The data mask rule description

Returns

The description of this DataMaskRuleSummary.

Return type

str

property display_name

Gets the display_name of this DataMaskRuleSummary. Data mask rule display name

Returns

The display_name of this DataMaskRuleSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this DataMaskRuleSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Avoid entering confidential information.

Returns

The freeform_tags of this DataMaskRuleSummary.

Return type

dict(str, str)

property iam_group_id

[Required] Gets the iam_group_id of this DataMaskRuleSummary. IAM group ID associated with the data mask rule

Returns

The iam_group_id of this DataMaskRuleSummary.

Return type

str

property id

[Required] Gets the id of this DataMaskRuleSummary. Unique identifier that can’t be changed after creation

Returns

The id of this DataMaskRuleSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this DataMaskRuleSummary. The current lifecycle state of the data mask rule

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

Returns

The lifecycle_state of this DataMaskRuleSummary.

Return type

str

property lifecyle_details

Gets the lifecyle_details of this DataMaskRuleSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. [DEPRECATE]

Returns

The lifecyle_details of this DataMaskRuleSummary.

Return type

str

property system_tags

Gets the system_tags of this DataMaskRuleSummary. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this DataMaskRuleSummary.

Return type

dict(str, dict(str, object))

property target_selected

[Required] Gets the target_selected of this DataMaskRuleSummary.

Returns

The target_selected of this DataMaskRuleSummary.

Return type

oci.cloud_guard.models.TargetSelected

property time_created

Gets the time_created of this DataMaskRuleSummary. The date and time the target was created. Format defined by RFC3339.

Returns

The time_created of this DataMaskRuleSummary.

Return type

datetime

property time_updated

Gets the time_updated of this DataMaskRuleSummary. The date and time the target was updated. Format defined by RFC3339.

Returns

The time_updated of this DataMaskRuleSummary.

Return type

datetime