@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public final class TagNamespace extends 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.
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
__explicitlySet__
. The hashCode()
and equals(Object)
methods are implemented to take
__explicitlySet__
into account. The constructor, on the other hand, does not set __explicitlySet__
(since the constructor cannot distinguish explicit null
from unset null
).
Modifier and Type | Class and Description |
---|---|
static class |
TagNamespace.Builder |
static class |
TagNamespace.LifecycleState
The tagnamespace’s current state.
|
Constructor and Description |
---|
TagNamespace(String id,
String compartmentId,
String name,
String description,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Boolean isRetired,
TagNamespace.LifecycleState lifecycleState,
Date timeCreated)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
static TagNamespace.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
Set<String> |
get__explicitlySet__() |
String |
getCompartmentId()
The OCID of the compartment that contains the tag namespace.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
The description you assign to the tag namespace.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the tag namespace.
|
Boolean |
getIsRetired()
Whether the tag namespace is retired.
|
TagNamespace.LifecycleState |
getLifecycleState()
The tagnamespace’s current state.
|
String |
getName()
The name of the tag namespace.
|
Date |
getTimeCreated()
Date and time the tagNamespace was created, in the format defined by RFC3339.
|
int |
hashCode() |
TagNamespace.Builder |
toBuilder() |
String |
toString() |
@ConstructorProperties(value={"id","compartmentId","name","description","freeformTags","definedTags","isRetired","lifecycleState","timeCreated"}) @Deprecated public TagNamespace(String id, String compartmentId, String name, String description, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Boolean isRetired, TagNamespace.LifecycleState lifecycleState, Date timeCreated)
public static TagNamespace.Builder builder()
Create a new builder.
public TagNamespace.Builder toBuilder()
public String getId()
The OCID of the tag namespace.
public String getCompartmentId()
The OCID of the compartment that contains the tag namespace.
public String getName()
The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
public String getDescription()
The description you assign to the tag namespace.
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()
Whether the tag namespace is retired. See Retiring Key Definitions and Namespace Definitions.
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.
public Date getTimeCreated()
Date and time the tagNamespace was created, in the format defined by RFC3339.
Example: 2016-08-25T21:10:29.600Z
Copyright © 2016–2022. All rights reserved.