Class Tag.Builder (1.60.0) 

public static final class Tag.Builder extends GeneratedMessageV3.Builder<Tag.Builder> implements TagOrBuilder

Tags are used to attach custom metadata to Data Catalog resources. Tags conform to the specifications within their tag template.

See Data Catalog IAM for information on the permissions needed to create or view tags.

Protobuf type google.cloud.datacatalog.v1beta1.Tag

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tag.Builder

Implements

TagOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public Tag build()
Returns
Type Description
Tag

buildPartial()

public Tag buildPartial()
Returns
Type Description
Tag

clear()

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

clearColumn()

public Tag.Builder clearColumn()

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Returns
Type Description
Tag.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearFields()

public Tag.Builder clearFields()
Returns
Type Description
Tag.Builder

clearName()

public Tag.Builder clearName()

Identifier. The resource name of the tag in URL format. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
Tag.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearScope()

public Tag.Builder clearScope()
Returns
Type Description
Tag.Builder

clearTemplate()

public Tag.Builder clearTemplate()

Required. The resource name of the tag template that this tag uses. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Tag.Builder

This builder for chaining.

clearTemplateDisplayName()

public Tag.Builder clearTemplateDisplayName()

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Tag.Builder

This builder for chaining.

clone()

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

containsFields(String key)

public boolean containsFields(String key)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
boolean

getColumn()

public String getColumn()

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Returns
Type Description
String

The column.

getColumnBytes()

public ByteString getColumnBytes()

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Returns
Type Description
ByteString

The bytes for column.

getDefaultInstanceForType()

public Tag getDefaultInstanceForType()
Returns
Type Description
Tag

getDescriptorForType()

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

getFields() (deprecated)

public Map<String,TagField> getFields()

Use #getFieldsMap() instead.

Returns
Type Description
Map<String,TagField>

getFieldsCount()

public int getFieldsCount()

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getFieldsMap()

public Map<String,TagField> getFieldsMap()

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Map<String,TagField>

getFieldsOrDefault(String key, TagField defaultValue)

public TagField getFieldsOrDefault(String key, TagField defaultValue)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
defaultValue TagField
Returns
Type Description
TagField

getFieldsOrThrow(String key)

public TagField getFieldsOrThrow(String key)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
TagField

getMutableFields() (deprecated)

public Map<String,TagField> getMutableFields()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,TagField>

getName()

public String getName()

Identifier. The resource name of the tag in URL format. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the tag in URL format. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getScopeCase()

public Tag.ScopeCase getScopeCase()
Returns
Type Description
Tag.ScopeCase

getTemplate()

public String getTemplate()

Required. The resource name of the tag template that this tag uses. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The template.

getTemplateBytes()

public ByteString getTemplateBytes()

Required. The resource name of the tag template that this tag uses. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for template.

getTemplateDisplayName()

public String getTemplateDisplayName()

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The templateDisplayName.

getTemplateDisplayNameBytes()

public ByteString getTemplateDisplayNameBytes()

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for templateDisplayName.

hasColumn()

public boolean hasColumn()

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Returns
Type Description
boolean

Whether the column field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Tag other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllFields(Map<String,TagField> values)

public Tag.Builder putAllFields(Map<String,TagField> values)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
values Map<String,TagField>
Returns
Type Description
Tag.Builder

putFields(String key, TagField value)

public Tag.Builder putFields(String key, TagField value)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name Description
key String
value TagField
Returns
Type Description
Tag.Builder

putFieldsBuilderIfAbsent(String key)

public TagField.Builder putFieldsBuilderIfAbsent(String key)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
TagField.Builder

removeFields(String key)

public Tag.Builder removeFields(String key)

Required. This maps the ID of a tag field to the value of and additional information about that field. Valid field IDs are defined by the tag's template. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1beta1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
key String
Returns
Type Description
Tag.Builder

setColumn(String value)

public Tag.Builder setColumn(String value)

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Parameter
Name Description
value String

The column to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setColumnBytes(ByteString value)

public Tag.Builder setColumnBytes(ByteString value)

Resources like Entry can have schemas associated with them. This scope allows users to attach tags to an individual column based on that schema.

For attaching a tag to a nested column, use . to separate the column names. Example:

  • outer_column.inner_column

string column = 4;

Parameter
Name Description
value ByteString

The bytes for column to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setName(String value)

public Tag.Builder setName(String value)

Identifier. The resource name of the tag in URL format. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Tag.Builder setNameBytes(ByteString value)

Identifier. The resource name of the tag in URL format. Example:

  • projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

    where tag_id is a system-generated identifier. Note that this Tag may not actually be stored in the location in this name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

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

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

setTemplate(String value)

public Tag.Builder setTemplate(String value)

Required. The resource name of the tag template that this tag uses. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The template to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setTemplateBytes(ByteString value)

public Tag.Builder setTemplateBytes(ByteString value)

Required. The resource name of the tag template that this tag uses. Example:

  • projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}

    This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for template to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setTemplateDisplayName(String value)

public Tag.Builder setTemplateDisplayName(String value)

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The templateDisplayName to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setTemplateDisplayNameBytes(ByteString value)

public Tag.Builder setTemplateDisplayNameBytes(ByteString value)

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for templateDisplayName to set.
Returns
Type Description
Tag.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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