Class EffectiveTag.Builder (1.46.0)

public static final class EffectiveTag.Builder extends GeneratedMessageV3.Builder<EffectiveTag.Builder> 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 Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public EffectiveTag.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EffectiveTag.Builder
Overrides

build()

public EffectiveTag build()
Returns
Type Description
EffectiveTag

buildPartial()

public EffectiveTag buildPartial()
Returns
Type Description
EffectiveTag

clear()

public EffectiveTag.Builder clear()
Returns
Type Description
EffectiveTag.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public EffectiveTag.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
EffectiveTag.Builder
Overrides

clearInherited()

public EffectiveTag.Builder clearInherited()

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
Type Description
EffectiveTag.Builder

This builder for chaining.

clearNamespacedTagKey()

public EffectiveTag.Builder clearNamespacedTagKey()

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
Type Description
EffectiveTag.Builder

This builder for chaining.

clearNamespacedTagValue()

public EffectiveTag.Builder clearNamespacedTagValue()

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
Type Description
EffectiveTag.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public EffectiveTag.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
EffectiveTag.Builder
Overrides

clearTagKey()

public EffectiveTag.Builder clearTagKey()

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

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

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

clearTagKeyParentName()

public EffectiveTag.Builder clearTagKeyParentName()

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
Type Description
EffectiveTag.Builder

This builder for chaining.

clearTagValue()

public EffectiveTag.Builder clearTagValue()

Resource name for TagValue in the format tagValues/456.

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

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

clone()

public EffectiveTag.Builder clone()
Returns
Type Description
EffectiveTag.Builder
Overrides

getDefaultInstanceForType()

public EffectiveTag getDefaultInstanceForType()
Returns
Type Description
EffectiveTag

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for namespacedTagValue.

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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for tagValue.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(EffectiveTag other)

public EffectiveTag.Builder mergeFrom(EffectiveTag other)
Parameter
Name Description
other EffectiveTag
Returns
Type Description
EffectiveTag.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EffectiveTag.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EffectiveTag.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public EffectiveTag.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
EffectiveTag.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final EffectiveTag.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EffectiveTag.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public EffectiveTag.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
EffectiveTag.Builder
Overrides

setInherited(boolean value)

public EffectiveTag.Builder setInherited(boolean value)

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;

Parameter
Name Description
value boolean

The inherited to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setNamespacedTagKey(String value)

public EffectiveTag.Builder setNamespacedTagKey(String value)

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;

Parameter
Name Description
value String

The namespacedTagKey to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setNamespacedTagKeyBytes(ByteString value)

public EffectiveTag.Builder setNamespacedTagKeyBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for namespacedTagKey to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setNamespacedTagValue(String value)

public EffectiveTag.Builder setNamespacedTagValue(String value)

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;

Parameter
Name Description
value String

The namespacedTagValue to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setNamespacedTagValueBytes(ByteString value)

public EffectiveTag.Builder setNamespacedTagValueBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for namespacedTagValue to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public EffectiveTag.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
EffectiveTag.Builder
Overrides

setTagKey(String value)

public EffectiveTag.Builder setTagKey(String value)

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

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

Parameter
Name Description
value String

The tagKey to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setTagKeyBytes(ByteString value)

public EffectiveTag.Builder setTagKeyBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for tagKey to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setTagKeyParentName(String value)

public EffectiveTag.Builder setTagKeyParentName(String value)

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;

Parameter
Name Description
value String

The tagKeyParentName to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setTagKeyParentNameBytes(ByteString value)

public EffectiveTag.Builder setTagKeyParentNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for tagKeyParentName to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setTagValue(String value)

public EffectiveTag.Builder setTagValue(String value)

Resource name for TagValue in the format tagValues/456.

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

Parameter
Name Description
value String

The tagValue to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setTagValueBytes(ByteString value)

public EffectiveTag.Builder setTagValueBytes(ByteString value)

Resource name for TagValue in the format tagValues/456.

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

Parameter
Name Description
value ByteString

The bytes for tagValue to set.

Returns
Type Description
EffectiveTag.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final EffectiveTag.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
EffectiveTag.Builder
Overrides