Package com.oracle.bmc.identity.model

Class TagNamespace

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class TagNamespace
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.
    Note: Objects should always be created or deserialized using the TagNamespace.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the TagNamespace.Builder, which maintain a set of all explicitly set fields called TagNamespace.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getId

        public String getId()
        The OCID of the tag namespace.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment that contains the tag namespace.
        Returns:
        the value

      • getName

        public String getName()
        The name of the tag namespace.

        It must be unique across all tag namespaces in the tenancy and cannot be changed.

        Returns:
        the value

      • getDescription

        public String getDescription()
        The description you assign to the tag namespace.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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 value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        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 value

      • getLifecycleState

        public TagNamespace.LifecycleState getLifecycleState()
        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.

        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Date and time the tagNamespace was created, in the format defined by RFC3339.

        Example: 2016-08-25T21:10:29.600Z

        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel