Class Tag.Builder (1.25.0)

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

Tags contain custom metadata and are attached to Data Catalog resources. Tags conform with the specification of their tag template.

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

Protobuf type google.cloud.datacatalog.v1.Tag

Implements

TagOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Tag.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Tag.Builder
Overrides

build()

public Tag build()
Returns
TypeDescription
Tag

buildPartial()

public Tag buildPartial()
Returns
TypeDescription
Tag

clear()

public Tag.Builder clear()
Returns
TypeDescription
Tag.Builder
Overrides

clearColumn()

public Tag.Builder clearColumn()

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

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
TypeDescription
Tag.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Tag.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Tag.Builder
Overrides

clearFields()

public Tag.Builder clearFields()
Returns
TypeDescription
Tag.Builder

clearName()

public Tag.Builder clearName()

The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1;

Returns
TypeDescription
Tag.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Tag.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Tag.Builder
Overrides

clearScope()

public Tag.Builder clearScope()
Returns
TypeDescription
Tag.Builder

clearTemplate()

public Tag.Builder clearTemplate()

Required. The resource name of the tag template 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
TypeDescription
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
TypeDescription
Tag.Builder

This builder for chaining.

clone()

public Tag.Builder clone()
Returns
TypeDescription
Tag.Builder
Overrides

containsFields(String key)

public boolean containsFields(String key)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getColumn()

public String getColumn()

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

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
TypeDescription
String

The column.

getColumnBytes()

public ByteString getColumnBytes()

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

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
TypeDescription
ByteString

The bytes for column.

getDefaultInstanceForType()

public Tag getDefaultInstanceForType()
Returns
TypeDescription
Tag

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFields()

public Map<String,TagField> getFields()

Use #getFieldsMap() instead.

Returns
TypeDescription
Map<String,TagField>

getFieldsCount()

public int getFieldsCount()

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Returns
TypeDescription
int

getFieldsMap()

public Map<String,TagField> getFieldsMap()

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Returns
TypeDescription
Map<String,TagField>

getFieldsOrDefault(String key, TagField defaultValue)

public TagField getFieldsOrDefault(String key, TagField defaultValue)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameters
NameDescription
keyString
defaultValueTagField
Returns
TypeDescription
TagField

getFieldsOrThrow(String key)

public TagField getFieldsOrThrow(String key)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
TagField

getMutableFields()

public Map<String,TagField> getMutableFields()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,TagField>

getName()

public String getName()

The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getScopeCase()

public Tag.ScopeCase getScopeCase()
Returns
TypeDescription
Tag.ScopeCase

getTemplate()

public String getTemplate()

Required. The resource name of the tag template 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
TypeDescription
String

The template.

getTemplateBytes()

public ByteString getTemplateBytes()

Required. The resource name of the tag template 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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for templateDisplayName.

hasColumn()

public boolean hasColumn()

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

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
TypeDescription
boolean

Whether the column field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Tag other)

public Tag.Builder mergeFrom(Tag other)
Parameter
NameDescription
otherTag
Returns
TypeDescription
Tag.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Tag.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Tag.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Tag.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Tag.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Tag.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Tag.Builder
Overrides

putAllFields(Map<String,TagField> values)

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

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameter
NameDescription
valuesMap<String,TagField>
Returns
TypeDescription
Tag.Builder

putFields(String key, TagField value)

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

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameters
NameDescription
keyString
valueTagField
Returns
TypeDescription
Tag.Builder

removeFields(String key)

public Tag.Builder removeFields(String key)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

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

Parameter
NameDescription
keyString
Returns
TypeDescription
Tag.Builder

setColumn(String value)

public Tag.Builder setColumn(String value)

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

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Parameter
NameDescription
valueString

The column to set.

Returns
TypeDescription
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 you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Parameter
NameDescription
valueByteString

The bytes for column to set.

Returns
TypeDescription
Tag.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Tag.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Tag.Builder
Overrides

setName(String value)

public Tag.Builder setName(String value)

The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Tag.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Tag.Builder setNameBytes(ByteString value)

The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Tag.Builder
Overrides

setTemplate(String value)

public Tag.Builder setTemplate(String value)

Required. The resource name of the tag template 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
NameDescription
valueString

The template to set.

Returns
TypeDescription
Tag.Builder

This builder for chaining.

setTemplateBytes(ByteString value)

public Tag.Builder setTemplateBytes(ByteString value)

Required. The resource name of the tag template 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
NameDescription
valueByteString

The bytes for template to set.

Returns
TypeDescription
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
NameDescription
valueString

The templateDisplayName to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for templateDisplayName to set.

Returns
TypeDescription
Tag.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Tag.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Tag.Builder
Overrides