@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
Tag.Builder |
static class |
Tag.LifecycleState
The tag’s current state.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
Tag(String compartmentId,
String tagNamespaceId,
String tagNamespaceName,
String id,
String name,
String description,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Boolean isRetired,
Tag.LifecycleState lifecycleState,
Date timeCreated,
Boolean isCostTracking,
BaseTagDefinitionValidator validator)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static Tag.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
String |
getCompartmentId()
The OCID of the compartment that contains the tag definition.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the tag.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the tag definition.
|
Boolean |
getIsCostTracking()
Indicates whether the tag is enabled for cost tracking.
|
Boolean |
getIsRetired()
Indicates whether the tag is retired.
|
Tag.LifecycleState |
getLifecycleState()
The tag’s current state.
|
String |
getName()
The name assigned to the tag during creation.
|
String |
getTagNamespaceId()
The OCID of the namespace that contains the tag definition.
|
String |
getTagNamespaceName()
The name of the tag namespace that contains the tag definition.
|
Date |
getTimeCreated()
Date and time the tag was created, in the format defined by RFC3339.
|
BaseTagDefinitionValidator |
getValidator() |
int |
hashCode() |
Tag.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","tagNamespaceId","tagNamespaceName","id","name","description","freeformTags","definedTags","isRetired","lifecycleState","timeCreated","isCostTracking","validator"}) public Tag(String compartmentId, String tagNamespaceId, String tagNamespaceName, String id, String name, String description, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Boolean isRetired, Tag.LifecycleState lifecycleState, Date timeCreated, Boolean isCostTracking, BaseTagDefinitionValidator validator)
public static Tag.Builder builder()
Create a new builder.
public Tag.Builder toBuilder()
public String getCompartmentId()
The OCID of the compartment that contains the tag definition.
public String getTagNamespaceId()
The OCID of the namespace that contains the tag definition.
public String getTagNamespaceName()
The name of the tag namespace that contains the tag definition.
public String getId()
The OCID of the tag definition.
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.
public String getDescription()
The description you assign to the tag.
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"}
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"}}
public Boolean getIsRetired()
Indicates whether the tag is retired. See Retiring Key Definitions and Namespace Definitions.
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.
public Date getTimeCreated()
Date and time the tag was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
public Boolean getIsCostTracking()
Indicates whether the tag is enabled for cost tracking.
public BaseTagDefinitionValidator getValidator()
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.