SensitiveTypeSummary

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

Bases: object

Summary of a sensitive type.

Attributes

ENTITY_TYPE_SENSITIVE_CATEGORY A constant which can be used with the entity_type property of a SensitiveTypeSummary.
ENTITY_TYPE_SENSITIVE_TYPE A constant which can be used with the entity_type property of a SensitiveTypeSummary.
LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a SensitiveTypeSummary.
SOURCE_ORACLE A constant which can be used with the source property of a SensitiveTypeSummary.
SOURCE_USER A constant which can be used with the source property of a SensitiveTypeSummary.
compartment_id [Required] Gets the compartment_id of this SensitiveTypeSummary.
default_masking_format_id Gets the default_masking_format_id of this SensitiveTypeSummary.
defined_tags Gets the defined_tags of this SensitiveTypeSummary.
description Gets the description of this SensitiveTypeSummary.
display_name [Required] Gets the display_name of this SensitiveTypeSummary.
entity_type [Required] Gets the entity_type of this SensitiveTypeSummary.
freeform_tags Gets the freeform_tags of this SensitiveTypeSummary.
id [Required] Gets the id of this SensitiveTypeSummary.
lifecycle_state [Required] Gets the lifecycle_state of this SensitiveTypeSummary.
parent_category_id Gets the parent_category_id of this SensitiveTypeSummary.
short_name Gets the short_name of this SensitiveTypeSummary.
source [Required] Gets the source of this SensitiveTypeSummary.
time_created [Required] Gets the time_created of this SensitiveTypeSummary.
time_updated [Required] Gets the time_updated of this SensitiveTypeSummary.

Methods

__init__(**kwargs) Initializes a new SensitiveTypeSummary object with values from keyword arguments.
ENTITY_TYPE_SENSITIVE_CATEGORY = 'SENSITIVE_CATEGORY'

A constant which can be used with the entity_type property of a SensitiveTypeSummary. 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 SensitiveTypeSummary. 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 SensitiveTypeSummary. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

SOURCE_ORACLE = 'ORACLE'

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

SOURCE_USER = 'USER'

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

__init__(**kwargs)

Initializes a new SensitiveTypeSummary 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 SensitiveTypeSummary.
  • display_name (str) – The value to assign to the display_name property of this SensitiveTypeSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this SensitiveTypeSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SensitiveTypeSummary. 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 SensitiveTypeSummary.
  • source (str) – The value to assign to the source property of this SensitiveTypeSummary. 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 SensitiveTypeSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this SensitiveTypeSummary.
  • description (str) – The value to assign to the description property of this SensitiveTypeSummary.
  • entity_type (str) – The value to assign to the entity_type property of this SensitiveTypeSummary. 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’.
  • parent_category_id (str) – The value to assign to the parent_category_id property of this SensitiveTypeSummary.
  • default_masking_format_id (str) – The value to assign to the default_masking_format_id property of this SensitiveTypeSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this SensitiveTypeSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this SensitiveTypeSummary.
compartment_id

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

Returns:The compartment_id of this SensitiveTypeSummary.
Return type:str
default_masking_format_id

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

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

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

Returns:The description of this SensitiveTypeSummary.
Return type:str
display_name

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

Returns:The display_name of this SensitiveTypeSummary.
Return type:str
entity_type

[Required] Gets the entity_type of this SensitiveTypeSummary. 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 SensitiveTypeSummary.
Return type:str
freeform_tags

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

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

Returns:The id of this SensitiveTypeSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this SensitiveTypeSummary. 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 SensitiveTypeSummary.
Return type:str
parent_category_id

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

Returns:The parent_category_id of this SensitiveTypeSummary.
Return type:str
short_name

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

Returns:The short_name of this SensitiveTypeSummary.
Return type:str
source

[Required] Gets the source of this SensitiveTypeSummary. 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 SensitiveTypeSummary.
Return type:str
time_created

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

Returns:The time_created of this SensitiveTypeSummary.
Return type:datetime
time_updated

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

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