Package com.oracle.bmc.identity.model

Class TagDefault

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class TagDefault
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Tag defaults let you specify a default tag (tagnamespace.tag=“value”) to apply to all resource types in a specified compartment.

    The tag default is applied at the time the resource is created. Resources that exist in the compartment before you create the tag default are not tagged. The TagDefault object specifies the tag and compartment details.

    Tag defaults are inherited by child compartments. This means that if you set a tag default on the root compartment for a tenancy, all resources that are created in the tenancy are tagged. For more information about using tag defaults, see [Managing Tag Defaults](https://docs.oracle.com/iaas/Content/Tagging/Tasks/managingtagdefaults.htm).

    To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.
    Note: Objects should always be created or deserialized using the TagDefault.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 TagDefault.Builder, which maintain a set of all explicitly set fields called TagDefault.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 default.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment.

        The tag default applies to all new resources that get created in the compartment. Resources that existed before the tag default was created are not tagged.

        Returns:
        the value

      • getTagNamespaceId

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

      • getTagDefinitionId

        public String getTagDefinitionId()
        The OCID of the tag definition.

        The tag default will always assign a default value for this tag definition.

        Returns:
        the value

      • getTagDefinitionName

        public String getTagDefinitionName()
        The name used in the tag definition.

        This field is informational in the context of the tag default.

        Returns:
        the value

      • getValue

        public String getValue()
        The default value for the tag definition.

        This will be applied to all resources created in the compartment.

        Returns:
        the value

      • getTimeCreated

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

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

        Returns:
        the value

      • getLifecycleState

        public TagDefault.LifecycleState getLifecycleState()
        The tag default’s current state.

        After creating a TagDefault, make sure its lifecycleState is ACTIVE before using it.

        Returns:
        the value

      • getIsRequired

        public Boolean getIsRequired()
        If you specify that a value is required, a value is set during resource creation (either by the user creating the resource or another tag defualt).

        If no value is set, resource creation is blocked.

        If the isRequired flag is set to "true", the value is set during resource creation. * If the isRequired flag is set to "false", the value you enter is set during resource creation.

        Example: false

        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