TagNamespace¶

class oci.identity.models.TagNamespace(**kwargs)¶

Bases: object

A managed container for defined tags. A tag namespace is unique in a tenancy. For more information, see Managing Tags and Tag Namespaces.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a TagNamespace.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a TagNamespace.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a TagNamespace.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a TagNamespace.
`compartment_id`	[Required] Gets the compartment_id of this TagNamespace.
`defined_tags`	Gets the defined_tags of this TagNamespace.
`description`	[Required] Gets the description of this TagNamespace.
`freeform_tags`	Gets the freeform_tags of this TagNamespace.
`id`	[Required] Gets the id of this TagNamespace.
`is_retired`	[Required] Gets the is_retired of this TagNamespace.
`lifecycle_state`	Gets the lifecycle_state of this TagNamespace.
`locks`	Gets the locks of this TagNamespace.
`name`	[Required] Gets the name of this TagNamespace.
`time_created`	[Required] Gets the time_created of this TagNamespace.

Methods

__init__(**kwargs) Initializes a new TagNamespace object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a TagNamespace. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a TagNamespace. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a TagNamespace. This constant has a value of “DELETING”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a TagNamespace. This constant has a value of “INACTIVE”

__init__(**kwargs)¶

Initializes a new TagNamespace 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 TagNamespace.
compartment_id (str) – The value to assign to the compartment_id property of this TagNamespace.
name (str) – The value to assign to the name property of this TagNamespace.
description (str) – The value to assign to the description property of this TagNamespace.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this TagNamespace.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this TagNamespace.
is_retired (bool) – The value to assign to the is_retired property of this TagNamespace.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this TagNamespace. Allowed values for this property are: “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, ‘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 TagNamespace.
locks (list[oci.identity.models.ResourceLock]) – The value to assign to the locks property of this TagNamespace.

compartment_id¶

[Required] Gets the compartment_id of this TagNamespace. The OCID of the compartment that contains the tag namespace.

Returns:	The compartment_id of this TagNamespace.
Return type:	str

defined_tags¶

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

description¶

[Required] Gets the description of this TagNamespace. The description you assign to the tag namespace.

Returns:	The description of this TagNamespace.
Return type:	str

freeform_tags¶

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

id¶

[Required] Gets the id of this TagNamespace. The OCID of the tag namespace.

Returns:	The id of this TagNamespace.
Return type:	str

is_retired¶

[Required] Gets the is_retired of this TagNamespace. Whether the tag namespace is retired. See Retiring Key Definitions and Namespace Definitions.

Returns:	The is_retired of this TagNamespace.
Return type:	bool

lifecycle_state¶

Gets the lifecycle_state of this TagNamespace. The tagnamespace’s current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

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

Returns:	The lifecycle_state of this TagNamespace.
Return type:	str

locks¶

Gets the locks of this TagNamespace. Locks associated with this resource.

Returns:	The locks of this TagNamespace.
Return type:	list[oci.identity.models.ResourceLock]

name¶

[Required] Gets the name of this TagNamespace. The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.

Returns:	The name of this TagNamespace.
Return type:	str

time_created¶

[Required] Gets the time_created of this TagNamespace. Date and time the tagNamespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

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