Package com.oracle.bmc.identity.model

Class Tag

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class Tag
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A tag definition that belongs to a specific tag namespace.

    “Defined tags” must be set up in your tenancy before you can apply them to resources. 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 Tag.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 Tag.Builder, which maintain a set of all explicitly set fields called Tag.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

      • builder

        public static Tag.Builder builder()
        Create a new builder.

      • getCompartmentId

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

      • getTagNamespaceId

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

      • getTagNamespaceName

        public String getTagNamespaceName()
        The name of the tag namespace that contains the tag definition.
        Returns:
        the value

      • getId

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

      • getName

        public String getName()
        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 value

      • getDescription

        public String getDescription()
        The description you assign to the tag.
        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 Tag.LifecycleState getLifecycleState()
        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 value

      • getTimeCreated

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

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

        Returns:
        the value

      • getIsCostTracking

        public Boolean getIsCostTracking()
        Indicates whether the tag is enabled for cost tracking.
        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