Class TagTemplate.Builder (1.38.0)

public static final class TagTemplate.Builder extends GeneratedMessageV3.Builder<TagTemplate.Builder> implements TagTemplateOrBuilder

A tag template defines a tag, which can have one or more typed fields. The template is used to create and attach the tag to Google Cloud resources. Tag template roles provide permissions to create, edit, and use the template. See, for example, the TagTemplate User role, which includes permission to use the tag template to tag resources.

Protobuf type google.cloud.datacatalog.v1beta1.TagTemplate

Inheritance

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

Implements

TagTemplateOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TagTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public TagTemplate build()

Returns
Type	Description
`TagTemplate`

buildPartial()

public TagTemplate buildPartial()

Returns
Type	Description
`TagTemplate`

clear()

public TagTemplate.Builder clear()

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDisplayName()

public TagTemplate.Builder clearDisplayName()

The display name for this template. Defaults to an empty string.

string display_name = 2;

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public TagTemplate.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFields()

public TagTemplate.Builder clearFields()

Returns
Type	Description
`TagTemplate.Builder`

clearName()

public TagTemplate.Builder clearName()

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

string name = 1;

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public TagTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public TagTemplate.Builder clone()

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

containsFields(String key)

public boolean containsFields(String key)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

The keys to this map are tag template field IDs. Field IDs can contain letters (both uppercase and lowercase), numbers (0-9) and underscores (_). Field IDs must be at least 1 character long and at most 64 characters long. Field IDs must start with a letter or underscore.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getDefaultInstanceForType()

public TagTemplate getDefaultInstanceForType()

Returns
Type	Description
`TagTemplate`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

The display name for this template. Defaults to an empty string.

string display_name = 2;

Returns
Type	Description
`String`	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name for this template. Defaults to an empty string.

string display_name = 2;

Returns
Type	Description
`ByteString`	The bytes for displayName.

getFields() (deprecated)

public Map<String,TagTemplateField> getFields()

Use #getFieldsMap() instead.

Returns
Type	Description
`Map<String,TagTemplateField>`

getFieldsCount()

public int getFieldsCount()

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Returns
Type	Description
`int`

getFieldsMap()

public Map<String,TagTemplateField> getFieldsMap()

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Returns
Type	Description
`Map<String,TagTemplateField>`

getFieldsOrDefault(String key, TagTemplateField defaultValue)

public TagTemplateField getFieldsOrDefault(String key, TagTemplateField defaultValue)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Parameters
Name	Description
`key`	`String`
`defaultValue`	`TagTemplateField`

Returns
Type	Description
`TagTemplateField`

getFieldsOrThrow(String key)

public TagTemplateField getFieldsOrThrow(String key)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`TagTemplateField`

getMutableFields() (deprecated)

public Map<String,TagTemplateField> getMutableFields()

Use alternate mutation accessors instead.

Returns
Type	Description
`Map<String,TagTemplateField>`

getName()

public String getName()

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

string name = 1;

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

string name = 1;

Returns
Type	Description
`ByteString`	The bytes for name.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMapField(int fieldNumber)

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)

Parameter
Name	Description
`number`	`int`

Returns
Type	Description
`MapField`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetMutableMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(TagTemplate other)

public TagTemplate.Builder mergeFrom(TagTemplate other)

Parameter
Name	Description
`other`	`TagTemplate`

Returns
Type	Description
`TagTemplate.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TagTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public TagTemplate.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

putAllFields(Map<String,TagTemplateField> values)

public TagTemplate.Builder putAllFields(Map<String,TagTemplateField> values)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Parameter
Name	Description
`values`	`Map<String,TagTemplateField>`

Returns
Type	Description
`TagTemplate.Builder`

putFields(String key, TagTemplateField value)

public TagTemplate.Builder putFields(String key, TagTemplateField value)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Parameters
Name	Description
`key`	`String`
`value`	`TagTemplateField`

Returns
Type	Description
`TagTemplate.Builder`

removeFields(String key)

public TagTemplate.Builder removeFields(String key)

Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. This map must contain at least one field and at most 500 fields.

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

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`TagTemplate.Builder`

setDisplayName(String value)

public TagTemplate.Builder setDisplayName(String value)

The display name for this template. Defaults to an empty string.

string display_name = 2;

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public TagTemplate.Builder setDisplayNameBytes(ByteString value)

The display name for this template. Defaults to an empty string.

string display_name = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public TagTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public TagTemplate.Builder setName(String value)

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

string name = 1;

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public TagTemplate.Builder setNameBytes(ByteString value)

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

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

Note that this TagTemplate and its child resources may not actually be stored in the location in this name.

string name = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`TagTemplate.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final TagTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`TagTemplate.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)