CreateSensitiveCategoryDetails

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

Bases: CreateSensitiveTypeDetails

Details to create a new sensitive category.

Attributes:

ENTITY_TYPE_SENSITIVE_CATEGORY

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

ENTITY_TYPE_SENSITIVE_TYPE

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

compartment_id

[Required] Gets the compartment_id of this CreateSensitiveTypeDetails.

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.

parent_category_id

Gets the parent_category_id of this CreateSensitiveTypeDetails.

short_name

Gets the short_name of this CreateSensitiveTypeDetails.

Methods:

__init__(**kwargs)

Initializes a new CreateSensitiveCategoryDetails 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 CreateSensitiveTypeDetails. 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 CreateSensitiveTypeDetails. This constant has a value of “SENSITIVE_TYPE”

__init__(**kwargs)

Initializes a new CreateSensitiveCategoryDetails object with values from keyword arguments. The default value of the entity_type attribute of this class is SENSITIVE_CATEGORY 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 CreateSensitiveCategoryDetails. Allowed values for this property are: “SENSITIVE_TYPE”, “SENSITIVE_CATEGORY”

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

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

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

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

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

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

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

property 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

property 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))

property description

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

Returns

The description of this CreateSensitiveTypeDetails.

Return type

str

property 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

property 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

property 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.

property 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

property 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