Class TagTemplate.Builder

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

A tag template defines a tag that can have one or more typed fields.
 The template is used to create tags that are attached to GCP resources.
 [Tag template roles]
 (https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles)
 provide permissions to create, edit, and use the template. For example,
 see the [TagTemplate User]
 (https://cloud.google.com/data-catalog/docs/how-to/template-user) role
 that includes a permission to use the tag template to tag resources.

Protobuf type google.cloud.datacatalog.v1.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.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

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.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)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

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

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

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)

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()

Display name for this template. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

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

clearIsPubliclyReadable()

public TagTemplate.Builder clearIsPubliclyReadable()

Indicates whether this is a public tag template.
 Every user has view access to a *public* tag template by default.
 This means that:
   * Every user can use this tag template to tag an entry.
   * If an entry is tagged using the tag template, the tag is always
     shown in the response to ``ListTags`` called on the entry.
   * To get the template using the GetTagTemplate method, you
     need view access either on the project or the organization the tag
     template resides in but no other permission is needed.
   * Operations on the tag template other than viewing (for example,
     editing IAM policies) follow standard IAM structures.
 Tags created with a public tag template are referred to as public tags.
 You can search for a public tag by value with a
 simple search query instead of using a ``tag:`` predicate.
 Public tag templates may not appear in search results depending on scope,
 see:
 [include_public_tag_templates][google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates]
 Note: If an [IAM domain
 restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
 is configured in the tag template's location, the public access will not be
 enabled but the simple search for tag values will still work.

bool is_publicly_readable = 5;

Returns

Type	Description
TagTemplate.Builder	This builder for chaining.

clearName()

public TagTemplate.Builder clearName()

The resource name of the tag template in URL format.
 Note: The tag template itself and its child resources might not be
 stored in the location specified in its 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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

Display name for this template. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 2;

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name for this template. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

string display_name = 2;

Returns

Type	Description
ByteString	The bytes for displayName.

getFields()

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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

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

Parameter

Name	Description
key	`String`

Returns

Type	Description
TagTemplateField

getIsPubliclyReadable()

public boolean getIsPubliclyReadable()

Indicates whether this is a public tag template.
 Every user has view access to a *public* tag template by default.
 This means that:
   * Every user can use this tag template to tag an entry.
   * If an entry is tagged using the tag template, the tag is always
     shown in the response to ``ListTags`` called on the entry.
   * To get the template using the GetTagTemplate method, you
     need view access either on the project or the organization the tag
     template resides in but no other permission is needed.
   * Operations on the tag template other than viewing (for example,
     editing IAM policies) follow standard IAM structures.
 Tags created with a public tag template are referred to as public tags.
 You can search for a public tag by value with a
 simple search query instead of using a ``tag:`` predicate.
 Public tag templates may not appear in search results depending on scope,
 see:
 [include_public_tag_templates][google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates]
 Note: If an [IAM domain
 restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
 is configured in the tag template's location, the public access will not be
 enabled but the simple search for tag values will still work.

bool is_publicly_readable = 5;

Returns

Type	Description
boolean	The isPubliclyReadable.

getMutableFields()

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.
 Note: The tag template itself and its child resources might not be
 stored in the location specified in its name.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the tag template in URL format.
 Note: The tag template itself and its child resources might not be
 stored in the location specified in its 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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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. The map must contain
 at least one field and at most 500 fields.
 The keys to this map are tag template field IDs. The IDs have the
 following limitations:
 * Can contain uppercase and lowercase letters, numbers (0-9) and
   underscores (_).
 * Must be at least 1 character and at most 64 characters long.
 * Must start with a letter or underscore.

map<string, .google.cloud.datacatalog.v1.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)

Display name for this template. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

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)

Display name for this template. Defaults to an empty string.
 The name must contain only Unicode letters, numbers (0-9), underscores (_),
 dashes (-), spaces ( ), and can't start or end with spaces.
 The maximum length is 200 characters.

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)

setIsPubliclyReadable(boolean value)

public TagTemplate.Builder setIsPubliclyReadable(boolean value)

Indicates whether this is a public tag template.
 Every user has view access to a *public* tag template by default.
 This means that:
   * Every user can use this tag template to tag an entry.
   * If an entry is tagged using the tag template, the tag is always
     shown in the response to ``ListTags`` called on the entry.
   * To get the template using the GetTagTemplate method, you
     need view access either on the project or the organization the tag
     template resides in but no other permission is needed.
   * Operations on the tag template other than viewing (for example,
     editing IAM policies) follow standard IAM structures.
 Tags created with a public tag template are referred to as public tags.
 You can search for a public tag by value with a
 simple search query instead of using a ``tag:`` predicate.
 Public tag templates may not appear in search results depending on scope,
 see:
 [include_public_tag_templates][google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates]
 Note: If an [IAM domain
 restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
 is configured in the tag template's location, the public access will not be
 enabled but the simple search for tag values will still work.

bool is_publicly_readable = 5;

Parameter

Name	Description
value	`boolean` The isPubliclyReadable to set.

Returns

Type	Description
TagTemplate.Builder	This builder for chaining.

setName(String value)

public TagTemplate.Builder setName(String value)

The resource name of the tag template in URL format.
 Note: The tag template itself and its child resources might not be
 stored in the location specified in its 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.
 Note: The tag template itself and its child resources might not be
 stored in the location specified in its 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)