com.google.api.services.cloudresourcemanager.v3.model

Class EffectiveTag

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudresourcemanager.v3.model.EffectiveTag

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class EffectiveTag
extends com.google.api.client.json.GenericJson

An EffectiveTag represents a tag that applies to a resource during policy evaluation. Tags can be either directly bound to a resource or inherited from its ancestor. EffectiveTag contains the name and namespaced_name of the tag value and tag key, with additional fields of `inherited` to indicate the inheritance status of the effective tag.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Resource Manager API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
EffectiveTag()

Method Summary

Modifier and Type	Method and Description
EffectiveTag	clone()
Boolean	getInherited() Indicates the inheritance status of a tag value attached to the given resource.
String	getNamespacedTagKey() The namespaced_name of the TagKey.
String	getNamespacedTagValue() Namespaced name of the TagValue.
String	getTagKey() The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
String	getTagKeyParentName() The parent name of the tag key.
String	getTagValue() Resource name for TagValue in the format `tagValues/456`.
EffectiveTag	set(String fieldName, Object value)
EffectiveTag	setInherited(Boolean inherited) Indicates the inheritance status of a tag value attached to the given resource.
EffectiveTag	setNamespacedTagKey(String namespacedTagKey) The namespaced_name of the TagKey.
EffectiveTag	setNamespacedTagValue(String namespacedTagValue) Namespaced name of the TagValue.
EffectiveTag	setTagKey(String tagKey) The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.
EffectiveTag	setTagKeyParentName(String tagKeyParentName) The parent name of the tag key.
EffectiveTag	setTagValue(String tagValue) Resource name for TagValue in the format `tagValues/456`.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

EffectiveTag

public EffectiveTag()

Method Detail

getInherited

public Boolean getInherited()

Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.

Returns:

value or null for none

setInherited

public EffectiveTag setInherited(Boolean inherited)

Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false.

Parameters:

inherited - inherited or null for none

getNamespacedTagKey

public String getNamespacedTagKey()

The namespaced_name of the TagKey. Now only supported in the format of `{organization_id}/{tag_key_short_name}`. Other formats will be supported when we add non-org parented tags.

Returns:

value or null for none

setNamespacedTagKey

public EffectiveTag setNamespacedTagKey(String namespacedTagKey)

The namespaced_name of the TagKey. Now only supported in the format of `{organization_id}/{tag_key_short_name}`. Other formats will be supported when we add non-org parented tags.

Parameters:

namespacedTagKey - namespacedTagKey or null for none

getNamespacedTagValue

public String getNamespacedTagValue()

Namespaced name of the TagValue. Now only supported in the format `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`. Other formats will be supported when we add non-org parented tags.

Returns:

value or null for none

setNamespacedTagValue

public EffectiveTag setNamespacedTagValue(String namespacedTagValue)

Namespaced name of the TagValue. Now only supported in the format `{organization_id}/{tag_key_short_name}/{tag_value_short_name}`. Other formats will be supported when we add non-org parented tags.

Parameters:

namespacedTagValue - namespacedTagValue or null for none

getTagKey

public String getTagKey()

The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.

Returns:

value or null for none

setTagKey

public EffectiveTag setTagKey(String tagKey)

The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`.

Parameters:

tagKey - tagKey or null for none

getTagKeyParentName

public String getTagKeyParentName()

The parent name of the tag key. Must be in the format `organizations/{organization_id}`.

Returns:

value or null for none

setTagKeyParentName

public EffectiveTag setTagKeyParentName(String tagKeyParentName)

The parent name of the tag key. Must be in the format `organizations/{organization_id}`.

Parameters:

tagKeyParentName - tagKeyParentName or null for none

getTagValue

public String getTagValue()

Resource name for TagValue in the format `tagValues/456`.

Returns:

value or null for none

setTagValue

public EffectiveTag setTagValue(String tagValue)

Resource name for TagValue in the format `tagValues/456`.

Parameters:

tagValue - tagValue or null for none

set

public EffectiveTag set(String fieldName,
                        Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public EffectiveTag clone()

Overrides:

clone in class com.google.api.client.json.GenericJson