public static final class TagTemplate.Builder extends com.google.protobuf.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](https://cloud.google.com/iam/docs/understanding-roles#data-catalog-roles) provide permissions to create, edit, and use the template. See, for example, the [TagTemplate User](https://cloud.google.com/data-catalog/docs/how-to/template-user) role, which includes permission to use the tag template to tag resources.Protobuf type
google.cloud.datacatalog.v1beta1.TagTemplate| Modifier and Type | Method and Description |
|---|---|
TagTemplate.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TagTemplate |
build() |
TagTemplate |
buildPartial() |
TagTemplate.Builder |
clear() |
TagTemplate.Builder |
clearDataplexTransferStatus()
Output only.
|
TagTemplate.Builder |
clearDisplayName()
The display name for this template.
|
TagTemplate.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
TagTemplate.Builder |
clearFields() |
TagTemplate.Builder |
clearName()
Identifier.
|
TagTemplate.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
TagTemplate.Builder |
clone() |
boolean |
containsFields(String key)
Required.
|
TagTemplate.DataplexTransferStatus |
getDataplexTransferStatus()
Output only.
|
int |
getDataplexTransferStatusValue()
Output only.
|
TagTemplate |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
String |
getDisplayName()
The display name for this template.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
The display name for this template.
|
Map<String,TagTemplateField> |
getFields()
Deprecated.
|
int |
getFieldsCount()
Required.
|
Map<String,TagTemplateField> |
getFieldsMap()
Required.
|
TagTemplateField |
getFieldsOrDefault(String key,
TagTemplateField defaultValue)
Required.
|
TagTemplateField |
getFieldsOrThrow(String key)
Required.
|
Map<String,TagTemplateField> |
getMutableFields()
Deprecated.
|
String |
getName()
Identifier.
|
com.google.protobuf.ByteString |
getNameBytes()
Identifier.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMutableMapFieldReflection(int number) |
boolean |
isInitialized() |
TagTemplate.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
TagTemplate.Builder |
mergeFrom(com.google.protobuf.Message other) |
TagTemplate.Builder |
mergeFrom(TagTemplate other) |
TagTemplate.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
TagTemplate.Builder |
putAllFields(Map<String,TagTemplateField> values)
Required.
|
TagTemplate.Builder |
putFields(String key,
TagTemplateField value)
Required.
|
TagTemplateField.Builder |
putFieldsBuilderIfAbsent(String key)
Required.
|
TagTemplate.Builder |
removeFields(String key)
Required.
|
TagTemplate.Builder |
setDataplexTransferStatus(TagTemplate.DataplexTransferStatus value)
Output only.
|
TagTemplate.Builder |
setDataplexTransferStatusValue(int value)
Output only.
|
TagTemplate.Builder |
setDisplayName(String value)
The display name for this template.
|
TagTemplate.Builder |
setDisplayNameBytes(com.google.protobuf.ByteString value)
The display name for this template.
|
TagTemplate.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
TagTemplate.Builder |
setName(String value)
Identifier.
|
TagTemplate.Builder |
setNameBytes(com.google.protobuf.ByteString value)
Identifier.
|
TagTemplate.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
TagTemplate.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic TagTemplate build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic TagTemplate buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic TagTemplate.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TagTemplate.Builder>public TagTemplate.Builder mergeFrom(TagTemplate other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public TagTemplate.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<TagTemplate.Builder>IOExceptionpublic String getName()
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];getName in interface TagTemplateOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];getNameBytes in interface TagTemplateOrBuilderpublic TagTemplate.Builder setName(String value)
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];value - The name to set.public TagTemplate.Builder clearName()
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];public TagTemplate.Builder setNameBytes(com.google.protobuf.ByteString value)
Identifier. 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 [(.google.api.field_behavior) = IDENTIFIER];value - The bytes for name to set.public String getDisplayName()
The display name for this template. Defaults to an empty string.
string display_name = 2;getDisplayName in interface TagTemplateOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
The display name for this template. Defaults to an empty string.
string display_name = 2;getDisplayNameBytes in interface TagTemplateOrBuilderpublic TagTemplate.Builder setDisplayName(String value)
The display name for this template. Defaults to an empty string.
string display_name = 2;value - The displayName to set.public TagTemplate.Builder clearDisplayName()
The display name for this template. Defaults to an empty string.
string display_name = 2;public TagTemplate.Builder setDisplayNameBytes(com.google.protobuf.ByteString value)
The display name for this template. Defaults to an empty string.
string display_name = 2;value - The bytes for displayName to set.public int getFieldsCount()
TagTemplateOrBuilderRequired. 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];
getFieldsCount in interface TagTemplateOrBuilderpublic 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];
containsFields in interface TagTemplateOrBuilder@Deprecated public Map<String,TagTemplateField> getFields()
getFieldsMap() instead.getFields in interface TagTemplateOrBuilderpublic 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. 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];
getFieldsMap in interface TagTemplateOrBuilderpublic 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. 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];
getFieldsOrDefault in interface TagTemplateOrBuilderpublic 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. 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];
getFieldsOrThrow in interface TagTemplateOrBuilderpublic TagTemplate.Builder clearFields()
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. 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];
@Deprecated public Map<String,TagTemplateField> getMutableFields()
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. 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];
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. 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];
public TagTemplateField.Builder putFieldsBuilderIfAbsent(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];
public int getDataplexTransferStatusValue()
Output only. Transfer status of the TagTemplate
.google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataplexTransferStatusValue in interface TagTemplateOrBuilderpublic TagTemplate.Builder setDataplexTransferStatusValue(int value)
Output only. Transfer status of the TagTemplate
.google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for dataplexTransferStatus to set.public TagTemplate.DataplexTransferStatus getDataplexTransferStatus()
Output only. Transfer status of the TagTemplate
.google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDataplexTransferStatus in interface TagTemplateOrBuilderpublic TagTemplate.Builder setDataplexTransferStatus(TagTemplate.DataplexTransferStatus value)
Output only. Transfer status of the TagTemplate
.google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The dataplexTransferStatus to set.public TagTemplate.Builder clearDataplexTransferStatus()
Output only. Transfer status of the TagTemplate
.google.cloud.datacatalog.v1beta1.TagTemplate.DataplexTransferStatus dataplex_transfer_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
public final TagTemplate.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>public final TagTemplate.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<TagTemplate.Builder>Copyright © 2025 Google LLC. All rights reserved.