Class EffectiveTag (1.19.0)

public final class EffectiveTag extends GeneratedMessageV3 implements EffectiveTagOrBuilder

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.

Protobuf type google.cloud.resourcemanager.v3.EffectiveTag

Static Fields

INHERITED_FIELD_NUMBER

public static final int INHERITED_FIELD_NUMBER
Field Value
TypeDescription
int

NAMESPACED_TAG_KEY_FIELD_NUMBER

public static final int NAMESPACED_TAG_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

NAMESPACED_TAG_VALUE_FIELD_NUMBER

public static final int NAMESPACED_TAG_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

TAG_KEY_FIELD_NUMBER

public static final int TAG_KEY_FIELD_NUMBER
Field Value
TypeDescription
int

TAG_KEY_PARENT_NAME_FIELD_NUMBER

public static final int TAG_KEY_PARENT_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

TAG_VALUE_FIELD_NUMBER

public static final int TAG_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static EffectiveTag getDefaultInstance()
Returns
TypeDescription
EffectiveTag

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static EffectiveTag.Builder newBuilder()
Returns
TypeDescription
EffectiveTag.Builder

newBuilder(EffectiveTag prototype)

public static EffectiveTag.Builder newBuilder(EffectiveTag prototype)
Parameter
NameDescription
prototypeEffectiveTag
Returns
TypeDescription
EffectiveTag.Builder

parseDelimitedFrom(InputStream input)

public static EffectiveTag parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static EffectiveTag parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EffectiveTag parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EffectiveTag parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static EffectiveTag parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static EffectiveTag parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EffectiveTag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
EffectiveTag
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<EffectiveTag> parser()
Returns
TypeDescription
Parser<EffectiveTag>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public EffectiveTag getDefaultInstanceForType()
Returns
TypeDescription
EffectiveTag

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.

bool inherited = 5;

Returns
TypeDescription
boolean

The inherited.

getNamespacedTagKey()

public String getNamespacedTagKey()

The namespaced name of the TagKey. Can be in the form {organization_id}/{tag_key_short_name} or {project_id}/{tag_key_short_name} or {project_number}/{tag_key_short_name}.

string namespaced_tag_key = 4;

Returns
TypeDescription
String

The namespacedTagKey.

getNamespacedTagKeyBytes()

public ByteString getNamespacedTagKeyBytes()

The namespaced name of the TagKey. Can be in the form {organization_id}/{tag_key_short_name} or {project_id}/{tag_key_short_name} or {project_number}/{tag_key_short_name}.

string namespaced_tag_key = 4;

Returns
TypeDescription
ByteString

The bytes for namespacedTagKey.

getNamespacedTagValue()

public String getNamespacedTagValue()

The namespaced name of the TagValue. Can be in the form {organization_id}/{tag_key_short_name}/{tag_value_short_name} or {project_id}/{tag_key_short_name}/{tag_value_short_name} or {project_number}/{tag_key_short_name}/{tag_value_short_name}.

string namespaced_tag_value = 2;

Returns
TypeDescription
String

The namespacedTagValue.

getNamespacedTagValueBytes()

public ByteString getNamespacedTagValueBytes()

The namespaced name of the TagValue. Can be in the form {organization_id}/{tag_key_short_name}/{tag_value_short_name} or {project_id}/{tag_key_short_name}/{tag_value_short_name} or {project_number}/{tag_key_short_name}/{tag_value_short_name}.

string namespaced_tag_value = 2;

Returns
TypeDescription
ByteString

The bytes for namespacedTagValue.

getParserForType()

public Parser<EffectiveTag> getParserForType()
Returns
TypeDescription
Parser<EffectiveTag>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTagKey()

public String getTagKey()

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

string tag_key = 3 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The tagKey.

getTagKeyBytes()

public ByteString getTagKeyBytes()

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

string tag_key = 3 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for tagKey.

getTagKeyParentName()

public String getTagKeyParentName()

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

string tag_key_parent_name = 6;

Returns
TypeDescription
String

The tagKeyParentName.

getTagKeyParentNameBytes()

public ByteString getTagKeyParentNameBytes()

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

string tag_key_parent_name = 6;

Returns
TypeDescription
ByteString

The bytes for tagKeyParentName.

getTagValue()

public String getTagValue()

Resource name for TagValue in the format tagValues/456.

string tag_value = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The tagValue.

getTagValueBytes()

public ByteString getTagValueBytes()

Resource name for TagValue in the format tagValues/456.

string tag_value = 1 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for tagValue.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public EffectiveTag.Builder newBuilderForType()
Returns
TypeDescription
EffectiveTag.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EffectiveTag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
EffectiveTag.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public EffectiveTag.Builder toBuilder()
Returns
TypeDescription
EffectiveTag.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException