SensitiveType

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

Bases: object

A sensitive type defines a particular type or class of sensitive data. It can be a basic sensitive type with regular expressions or a sensitive category. While sensitive types are used for data discovery, sensitive categories are used for logically grouping the related or similar sensitive types. Learn more.

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.
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.
compartment_id [Required] Gets the compartment_id of this SensitiveType.
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.
lifecycle_state [Required] Gets the lifecycle_state of this SensitiveType.
parent_category_id Gets the parent_category_id of this SensitiveType.
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 SensitiveType 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”

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 SensitiveType object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 SensitiveType.
  • entity_type (str) – The value to assign to the entity_type property of this SensitiveType. 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 SensitiveType.
  • compartment_id (str) – The value to assign to the compartment_id property of this SensitiveType.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SensitiveType. 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 SensitiveType.
  • source (str) – The value to assign to the source property of this SensitiveType. 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 SensitiveType.
  • time_updated (datetime) – The value to assign to the time_updated property of this SensitiveType.
  • description (str) – The value to assign to the description property of this SensitiveType.
  • parent_category_id (str) – The value to assign to the parent_category_id property of this SensitiveType.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SensitiveType.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SensitiveType.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this SensitiveType.
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
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))
description

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

Returns:The description of this SensitiveType.
Return type:str
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
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
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.

id

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

Returns:The id of this SensitiveType.
Return type:str
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
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
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
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
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))
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
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