SensitiveTypePattern

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

Bases: SensitiveType

Details of the sensitive type.

Attributes:

ENTITY_TYPE_SENSITIVE_CATEGORY

A constant which can be used with the entity_type property of a SensitiveType.

ENTITY_TYPE_SENSITIVE_TYPE

A constant which can be used with the entity_type property of a SensitiveType.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

LIFECYCLE_STATE_UPDATING

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

SEARCH_TYPE_AND

A constant which can be used with the search_type property of a SensitiveTypePattern.

SEARCH_TYPE_OR

A constant which can be used with the search_type property of a SensitiveTypePattern.

SOURCE_ORACLE

A constant which can be used with the source property of a SensitiveType.

SOURCE_USER

A constant which can be used with the source property of a SensitiveType.

comment_pattern

Gets the comment_pattern of this SensitiveTypePattern.

compartment_id

[Required] Gets the compartment_id of this SensitiveType.

data_pattern

Gets the data_pattern of this SensitiveTypePattern.

default_masking_format_id

Gets the default_masking_format_id of this SensitiveTypePattern.

defined_tags

Gets the defined_tags of this SensitiveType.

description

Gets the description of this SensitiveType.

display_name

[Required] Gets the display_name of this SensitiveType.

entity_type

[Required] Gets the entity_type of this SensitiveType.

freeform_tags

Gets the freeform_tags of this SensitiveType.

id

[Required] Gets the id of this SensitiveType.

is_common

Gets the is_common of this SensitiveType.

lifecycle_state

[Required] Gets the lifecycle_state of this SensitiveType.

name_pattern

Gets the name_pattern of this SensitiveTypePattern.

parent_category_id

Gets the parent_category_id of this SensitiveType.

search_type

Gets the search_type of this SensitiveTypePattern.

short_name

Gets the short_name of this SensitiveType.

source

[Required] Gets the source of this SensitiveType.

system_tags

Gets the system_tags of this SensitiveType.

time_created

[Required] Gets the time_created of this SensitiveType.

time_updated

[Required] Gets the time_updated of this SensitiveType.

Methods:

__init__(**kwargs)

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

ENTITY_TYPE_SENSITIVE_CATEGORY = 'SENSITIVE_CATEGORY'

A constant which can be used with the entity_type property of a SensitiveType. This constant has a value of “SENSITIVE_CATEGORY”

ENTITY_TYPE_SENSITIVE_TYPE = 'SENSITIVE_TYPE'

A constant which can be used with the entity_type property of a SensitiveType. This constant has a value of “SENSITIVE_TYPE”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SEARCH_TYPE_AND = 'AND'

A constant which can be used with the search_type property of a SensitiveTypePattern. This constant has a value of “AND”

SEARCH_TYPE_OR = 'OR'

A constant which can be used with the search_type property of a SensitiveTypePattern. This constant has a value of “OR”

SOURCE_ORACLE = 'ORACLE'

A constant which can be used with the source property of a SensitiveType. This constant has a value of “ORACLE”

SOURCE_USER = 'USER'

A constant which can be used with the source property of a SensitiveType. This constant has a value of “USER”

__init__(**kwargs)

Initializes a new SensitiveTypePattern object with values from keyword arguments. The default value of the entity_type attribute of this class is SENSITIVE_TYPE and it should not be changed. 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 SensitiveTypePattern.

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

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

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

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

  • short_name (str) – The value to assign to the short_name property of this SensitiveTypePattern.

  • source (str) – The value to assign to the source property of this SensitiveTypePattern. 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’.

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

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

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

  • parent_category_id (str) – The value to assign to the parent_category_id property of this SensitiveTypePattern.

  • is_common (bool) – The value to assign to the is_common property of this SensitiveTypePattern.

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

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

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

  • name_pattern (str) – The value to assign to the name_pattern property of this SensitiveTypePattern.

  • comment_pattern (str) – The value to assign to the comment_pattern property of this SensitiveTypePattern.

  • data_pattern (str) – The value to assign to the data_pattern property of this SensitiveTypePattern.

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

  • default_masking_format_id (str) – The value to assign to the default_masking_format_id property of this SensitiveTypePattern.

property comment_pattern

Gets the comment_pattern of this SensitiveTypePattern. A regular expression to be used by data discovery for matching column comments.

Returns

The comment_pattern of this SensitiveTypePattern.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this SensitiveType. The OCID of the compartment that contains the sensitive type.

Returns

The compartment_id of this SensitiveType.

Return type

str

property data_pattern

Gets the data_pattern of this SensitiveTypePattern. A regular expression to be used by data discovery for matching column data values.

Returns

The data_pattern of this SensitiveTypePattern.

Return type

str

property default_masking_format_id

Gets the default_masking_format_id of this SensitiveTypePattern. The OCID of the library masking format that should be used to mask the sensitive columns associated with the sensitive type.

Returns

The default_masking_format_id of this SensitiveTypePattern.

Return type

str

property defined_tags

Gets the defined_tags of this SensitiveType. 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 SensitiveType.

Return type

dict(str, dict(str, object))

property description

Gets the description of this SensitiveType. The description of the sensitive type.

Returns

The description of this SensitiveType.

Return type

str

property display_name

[Required] Gets the display_name of this SensitiveType. The display name of the sensitive type.

Returns

The display_name of this SensitiveType.

Return type

str

property entity_type

[Required] Gets the entity_type of this SensitiveType. The entity type. It can be either a sensitive type with regular expressions or a sensitive category used for grouping similar sensitive types.

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

Returns

The entity_type of this SensitiveType.

Return type

str

property freeform_tags

Gets the freeform_tags of this SensitiveType. 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 SensitiveType.

Return type

dict(str, str)

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 id

[Required] Gets the id of this SensitiveType. The OCID of the sensitive type.

Returns

The id of this SensitiveType.

Return type

str

property is_common

Gets the is_common of this SensitiveType. Specifies whether the sensitive type is common. Common sensitive types belong to library sensitive types which are frequently used to perform sensitive data discovery.

Returns

The is_common of this SensitiveType.

Return type

bool

property lifecycle_state

[Required] Gets the lifecycle_state of this SensitiveType. The current state of the sensitive type.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “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 SensitiveType.

Return type

str

property name_pattern

Gets the name_pattern of this SensitiveTypePattern. A regular expression to be used by data discovery for matching column names.

Returns

The name_pattern of this SensitiveTypePattern.

Return type

str

property parent_category_id

Gets the parent_category_id of this SensitiveType. The OCID of the parent sensitive category.

Returns

The parent_category_id of this SensitiveType.

Return type

str

property search_type

Gets the search_type of this SensitiveTypePattern. The search type indicating how the column name, comment and data patterns should be used by data discovery. Learn more.

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

Returns

The search_type of this SensitiveTypePattern.

Return type

str

property short_name

Gets the short_name of this SensitiveType. The short name of the sensitive type.

Returns

The short_name of this SensitiveType.

Return type

str

property source

[Required] Gets the source of this SensitiveType. Specifies whether the sensitive type 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 SensitiveType.

Return type

str

property system_tags

Gets the system_tags of this SensitiveType. System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this SensitiveType.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this SensitiveType. The date and time the sensitive type was created, in the format defined by RFC3339.

Returns

The time_created of this SensitiveType.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this SensitiveType. The date and time the sensitive type was last updated, in the format defined by RFC3339.

Returns

The time_updated of this SensitiveType.

Return type

datetime