CreateSensitiveTypePatternDetails¶

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

Bases: oci.data_safe.models.create_sensitive_type_details.CreateSensitiveTypeDetails

Details to create a new sensitive type with regular expressions.

Attributes

`ENTITY_TYPE_SENSITIVE_CATEGORY`	str(object=’’) -> str
`ENTITY_TYPE_SENSITIVE_TYPE`	str(object=’’) -> str
`comment_pattern`	Gets the comment_pattern of this CreateSensitiveTypePatternDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateSensitiveTypeDetails.
`data_pattern`	Gets the data_pattern of this CreateSensitiveTypePatternDetails.
`default_masking_format_id`	Gets the default_masking_format_id of this CreateSensitiveTypePatternDetails.
`defined_tags`	Gets the defined_tags of this CreateSensitiveTypeDetails.
`description`	Gets the description of this CreateSensitiveTypeDetails.
`display_name`	Gets the display_name of this CreateSensitiveTypeDetails.
`entity_type`	[Required] Gets the entity_type of this CreateSensitiveTypeDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSensitiveTypeDetails.
`name_pattern`	Gets the name_pattern of this CreateSensitiveTypePatternDetails.
`parent_category_id`	Gets the parent_category_id of this CreateSensitiveTypeDetails.
`search_type`	Gets the search_type of this CreateSensitiveTypePatternDetails.
`short_name`	Gets the short_name of this CreateSensitiveTypeDetails.

Methods

`__init__`(**kwargs)	Initializes a new CreateSensitiveTypePatternDetails 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'¶

ENTITY_TYPE_SENSITIVE_TYPE = 'SENSITIVE_TYPE'¶

__init__(**kwargs)¶

Initializes a new CreateSensitiveTypePatternDetails 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:

entity_type (str) – The value to assign to the entity_type property of this CreateSensitiveTypePatternDetails. Allowed values for this property are: “SENSITIVE_TYPE”, “SENSITIVE_CATEGORY”
display_name (str) – The value to assign to the display_name property of this CreateSensitiveTypePatternDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateSensitiveTypePatternDetails.
short_name (str) – The value to assign to the short_name property of this CreateSensitiveTypePatternDetails.
description (str) – The value to assign to the description property of this CreateSensitiveTypePatternDetails.
parent_category_id (str) – The value to assign to the parent_category_id property of this CreateSensitiveTypePatternDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSensitiveTypePatternDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSensitiveTypePatternDetails.
name_pattern (str) – The value to assign to the name_pattern property of this CreateSensitiveTypePatternDetails.
comment_pattern (str) – The value to assign to the comment_pattern property of this CreateSensitiveTypePatternDetails.
data_pattern (str) – The value to assign to the data_pattern property of this CreateSensitiveTypePatternDetails.
search_type (str) – The value to assign to the search_type property of this CreateSensitiveTypePatternDetails.
default_masking_format_id (str) – The value to assign to the default_masking_format_id property of this CreateSensitiveTypePatternDetails.

comment_pattern¶

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

Returns:	The comment_pattern of this CreateSensitiveTypePatternDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateSensitiveTypeDetails. The OCID of the compartment where the sensitive type should be created.

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

data_pattern¶

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

Returns:	The data_pattern of this CreateSensitiveTypePatternDetails.
Return type:	str

default_masking_format_id¶

Gets the default_masking_format_id of this CreateSensitiveTypePatternDetails. 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 CreateSensitiveTypePatternDetails.
Return type:	str

defined_tags¶

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

description¶

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

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

display_name¶

Gets the display_name of this CreateSensitiveTypeDetails. The display name of the sensitive type. The name does not have to be unique, and it’s changeable.

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

entity_type¶

[Required] Gets the entity_type of this CreateSensitiveTypeDetails. 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”

Returns:	The entity_type of this CreateSensitiveTypeDetails.
Return type:	str

freeform_tags¶

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

name_pattern¶

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

Returns:	The name_pattern of this CreateSensitiveTypePatternDetails.
Return type:	str

parent_category_id¶

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

Returns:	The parent_category_id of this CreateSensitiveTypeDetails.
Return type:	str

search_type¶

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

Returns:	The search_type of this CreateSensitiveTypePatternDetails.
Return type:	str

short_name¶

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

Returns:	The short_name of this CreateSensitiveTypeDetails.
Return type:	str