File: //proc/self/root/lib/mysqlsh/lib/python3.8/site-packages/oci/identity/models/tag_namespace.py
# coding: utf-8
# Copyright (c) 2016, 2025, Oracle and/or its affiliates. All rights reserved.
# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
# NOTE: This class is auto generated by OracleSDKGenerator. DO NOT EDIT. API Version: 20160918
from oci.util import formatted_flat_dict, NONE_SENTINEL, value_allowed_none_or_none_sentinel # noqa: F401
from oci.decorators import init_model_state_from_kwargs
@init_model_state_from_kwargs
class TagNamespace(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.
__ https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm
"""
#: A constant which can be used with the lifecycle_state property of a TagNamespace.
#: This constant has a value of "ACTIVE"
LIFECYCLE_STATE_ACTIVE = "ACTIVE"
#: A constant which can be used with the lifecycle_state property of a TagNamespace.
#: This constant has a value of "INACTIVE"
LIFECYCLE_STATE_INACTIVE = "INACTIVE"
#: A constant which can be used with the lifecycle_state property of a TagNamespace.
#: This constant has a value of "DELETING"
LIFECYCLE_STATE_DELETING = "DELETING"
#: A constant which can be used with the lifecycle_state property of a TagNamespace.
#: This constant has a value of "DELETED"
LIFECYCLE_STATE_DELETED = "DELETED"
def __init__(self, **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):
:param id:
The value to assign to the id property of this TagNamespace.
:type id: str
:param compartment_id:
The value to assign to the compartment_id property of this TagNamespace.
:type compartment_id: str
:param name:
The value to assign to the name property of this TagNamespace.
:type name: str
:param description:
The value to assign to the description property of this TagNamespace.
:type description: str
:param freeform_tags:
The value to assign to the freeform_tags property of this TagNamespace.
:type freeform_tags: dict(str, str)
:param defined_tags:
The value to assign to the defined_tags property of this TagNamespace.
:type defined_tags: dict(str, dict(str, object))
:param is_retired:
The value to assign to the is_retired property of this TagNamespace.
:type is_retired: bool
:param lifecycle_state:
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'.
:type lifecycle_state: str
:param time_created:
The value to assign to the time_created property of this TagNamespace.
:type time_created: datetime
:param locks:
The value to assign to the locks property of this TagNamespace.
:type locks: list[oci.identity.models.ResourceLock]
"""
self.swagger_types = {
'id': 'str',
'compartment_id': 'str',
'name': 'str',
'description': 'str',
'freeform_tags': 'dict(str, str)',
'defined_tags': 'dict(str, dict(str, object))',
'is_retired': 'bool',
'lifecycle_state': 'str',
'time_created': 'datetime',
'locks': 'list[ResourceLock]'
}
self.attribute_map = {
'id': 'id',
'compartment_id': 'compartmentId',
'name': 'name',
'description': 'description',
'freeform_tags': 'freeformTags',
'defined_tags': 'definedTags',
'is_retired': 'isRetired',
'lifecycle_state': 'lifecycleState',
'time_created': 'timeCreated',
'locks': 'locks'
}
self._id = None
self._compartment_id = None
self._name = None
self._description = None
self._freeform_tags = None
self._defined_tags = None
self._is_retired = None
self._lifecycle_state = None
self._time_created = None
self._locks = None
@property
def id(self):
"""
**[Required]** Gets the id of this TagNamespace.
The OCID of the tag namespace.
:return: The id of this TagNamespace.
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""
Sets the id of this TagNamespace.
The OCID of the tag namespace.
:param id: The id of this TagNamespace.
:type: str
"""
self._id = id
@property
def compartment_id(self):
"""
**[Required]** Gets the compartment_id of this TagNamespace.
The OCID of the compartment that contains the tag namespace.
:return: The compartment_id of this TagNamespace.
:rtype: str
"""
return self._compartment_id
@compartment_id.setter
def compartment_id(self, compartment_id):
"""
Sets the compartment_id of this TagNamespace.
The OCID of the compartment that contains the tag namespace.
:param compartment_id: The compartment_id of this TagNamespace.
:type: str
"""
self._compartment_id = compartment_id
@property
def name(self):
"""
**[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.
:return: The name of this TagNamespace.
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""
Sets 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.
:param name: The name of this TagNamespace.
:type: str
"""
self._name = name
@property
def description(self):
"""
**[Required]** Gets the description of this TagNamespace.
The description you assign to the tag namespace.
:return: The description of this TagNamespace.
:rtype: str
"""
return self._description
@description.setter
def description(self, description):
"""
Sets the description of this TagNamespace.
The description you assign to the tag namespace.
:param description: The description of this TagNamespace.
:type: str
"""
self._description = description
@property
def freeform_tags(self):
"""
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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The freeform_tags of this TagNamespace.
:rtype: dict(str, str)
"""
return self._freeform_tags
@freeform_tags.setter
def freeform_tags(self, freeform_tags):
"""
Sets 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\"}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param freeform_tags: The freeform_tags of this TagNamespace.
:type: dict(str, str)
"""
self._freeform_tags = freeform_tags
@property
def defined_tags(self):
"""
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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:return: The defined_tags of this TagNamespace.
:rtype: dict(str, dict(str, object))
"""
return self._defined_tags
@defined_tags.setter
def defined_tags(self, defined_tags):
"""
Sets 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\"}}`
__ https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm
:param defined_tags: The defined_tags of this TagNamespace.
:type: dict(str, dict(str, object))
"""
self._defined_tags = defined_tags
@property
def is_retired(self):
"""
**[Required]** Gets the is_retired of this TagNamespace.
Whether the tag namespace is retired.
See `Retiring Key Definitions and Namespace Definitions`__.
__ https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys
:return: The is_retired of this TagNamespace.
:rtype: bool
"""
return self._is_retired
@is_retired.setter
def is_retired(self, is_retired):
"""
Sets the is_retired of this TagNamespace.
Whether the tag namespace is retired.
See `Retiring Key Definitions and Namespace Definitions`__.
__ https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm#retiringkeys
:param is_retired: The is_retired of this TagNamespace.
:type: bool
"""
self._is_retired = is_retired
@property
def lifecycle_state(self):
"""
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'.
:return: The lifecycle_state of this TagNamespace.
:rtype: str
"""
return self._lifecycle_state
@lifecycle_state.setter
def lifecycle_state(self, lifecycle_state):
"""
Sets 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.
:param lifecycle_state: The lifecycle_state of this TagNamespace.
:type: str
"""
allowed_values = ["ACTIVE", "INACTIVE", "DELETING", "DELETED"]
if not value_allowed_none_or_none_sentinel(lifecycle_state, allowed_values):
lifecycle_state = 'UNKNOWN_ENUM_VALUE'
self._lifecycle_state = lifecycle_state
@property
def time_created(self):
"""
**[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`
:return: The time_created of this TagNamespace.
:rtype: datetime
"""
return self._time_created
@time_created.setter
def time_created(self, time_created):
"""
Sets 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`
:param time_created: The time_created of this TagNamespace.
:type: datetime
"""
self._time_created = time_created
@property
def locks(self):
"""
Gets the locks of this TagNamespace.
Locks associated with this resource.
:return: The locks of this TagNamespace.
:rtype: list[oci.identity.models.ResourceLock]
"""
return self._locks
@locks.setter
def locks(self, locks):
"""
Sets the locks of this TagNamespace.
Locks associated with this resource.
:param locks: The locks of this TagNamespace.
:type: list[oci.identity.models.ResourceLock]
"""
self._locks = locks
def __repr__(self):
return formatted_flat_dict(self)
def __eq__(self, other):
if other is None:
return False
return self.__dict__ == other.__dict__
def __ne__(self, other):
return not self == other