TagSummary

class oci.identity.models.TagSummary(**kwargs)

Bases: object

A tag definition that belongs to a specific tag namespace.

__init__(**kwargs)

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

Parameters:
  • compartment_id (str) -- The value to assign to the compartment_id property of this TagSummary.
  • id (str) -- The value to assign to the id property of this TagSummary.
  • name (str) -- The value to assign to the name property of this TagSummary.
  • description (str) -- The value to assign to the description property of this TagSummary.
  • freeform_tags (dict(str, str)) -- The value to assign to the freeform_tags property of this TagSummary.
  • defined_tags (dict(str, dict(str, object))) -- The value to assign to the defined_tags property of this TagSummary.
  • is_retired (bool) -- The value to assign to the is_retired property of this TagSummary.
  • lifecycle_state (str) -- The value to assign to the lifecycle_state property of this TagSummary.
  • time_created (datetime) -- The value to assign to the time_created property of this TagSummary.
  • is_cost_tracking (bool) -- The value to assign to the is_cost_tracking property of this TagSummary.
compartment_id

Gets the compartment_id of this TagSummary. The OCID of the compartment that contains the tag definition.

Returns:The compartment_id of this TagSummary.
Return type:str
defined_tags

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

Gets the description of this TagSummary. The description you assign to the tag.

Returns:The description of this TagSummary.
Return type:str
freeform_tags

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

Gets the id of this TagSummary. The OCID of the tag definition.

Returns:The id of this TagSummary.
Return type:str
is_cost_tracking

Gets the is_cost_tracking of this TagSummary. Indicates whether the tag is enabled for cost tracking.

Returns:The is_cost_tracking of this TagSummary.
Return type:bool
is_retired

Gets the is_retired of this TagSummary. Whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.

Returns:The is_retired of this TagSummary.
Return type:bool
lifecycle_state

Gets the lifecycle_state of this TagSummary. The tag's current state. After creating a tag, make sure its lifecycleState is ACTIVE before using it. After retiring a tag, make sure its lifecycleState is INACTIVE before using it. If you delete a tag, you cannot delete another tag until the deleted tag's lifecycleState changes from DELETING to DELETED.

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

Gets the name of this TagSummary. The name assigned to the tag during creation. This is the tag key definition. The name must be unique within the tag namespace and cannot be changed.

Returns:The name of this TagSummary.
Return type:str
time_created

Gets the time_created of this TagSummary. Date and time the tag was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Returns:The time_created of this TagSummary.
Return type:datetime