EntityTag

class oci.data_catalog.models.EntityTag(**kwargs)

Bases: object

Represents an association of an entity to a term.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_MOVING A constant which can be used with the lifecycle_state property of a EntityTag.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a EntityTag.
created_by_id Gets the created_by_id of this EntityTag.
entity_key Gets the entity_key of this EntityTag.
key [Required] Gets the key of this EntityTag.
lifecycle_state Gets the lifecycle_state of this EntityTag.
name Gets the name of this EntityTag.
term_description Gets the term_description of this EntityTag.
term_key Gets the term_key of this EntityTag.
term_path Gets the term_path of this EntityTag.
time_created Gets the time_created of this EntityTag.
uri Gets the uri of this EntityTag.

Methods

__init__(**kwargs) Initializes a new EntityTag object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_MOVING = 'MOVING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

Initializes a new EntityTag object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • entity_key (str) – The value to assign to the entity_key property of this EntityTag.
  • key (str) – The value to assign to the key property of this EntityTag.
  • name (str) – The value to assign to the name property of this EntityTag.
  • term_key (str) – The value to assign to the term_key property of this EntityTag.
  • term_path (str) – The value to assign to the term_path property of this EntityTag.
  • term_description (str) – The value to assign to the term_description property of this EntityTag.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this EntityTag. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘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 EntityTag.
  • created_by_id (str) – The value to assign to the created_by_id property of this EntityTag.
  • uri (str) – The value to assign to the uri property of this EntityTag.
created_by_id

Gets the created_by_id of this EntityTag. OCID of the user who created the tag.

Returns:The created_by_id of this EntityTag.
Return type:str
entity_key

Gets the entity_key of this EntityTag. The unique key of the parent entity.

Returns:The entity_key of this EntityTag.
Return type:str
key

[Required] Gets the key of this EntityTag. Unique tag key that is immutable.

Returns:The key of this EntityTag.
Return type:str
lifecycle_state

Gets the lifecycle_state of this EntityTag. The current state of the tag.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “MOVING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The lifecycle_state of this EntityTag.
Return type:str
name

Gets the name of this EntityTag. Name of the tag which matches the term name.

Returns:The name of this EntityTag.
Return type:str
term_description

Gets the term_description of this EntityTag. Description of the related term.

Returns:The term_description of this EntityTag.
Return type:str
term_key

Gets the term_key of this EntityTag. Unique key of the related term.

Returns:The term_key of this EntityTag.
Return type:str
term_path

Gets the term_path of this EntityTag. Path of the related term.

Returns:The term_path of this EntityTag.
Return type:str
time_created

Gets the time_created of this EntityTag. The date and time the tag was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:The time_created of this EntityTag.
Return type:datetime
uri

Gets the uri of this EntityTag. URI to the tag instance in the API.

Returns:The uri of this EntityTag.
Return type:str