- 1.59.0 (latest)
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
public static final class TagTemplate.Builder extends GeneratedMessageV3.Builder<TagTemplate.Builder> implements TagTemplateOrBuilderA 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.BuilderImplements
TagTemplateOrBuilderStatic 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 |
|
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 |
|
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 |
|
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 |
|
clone()
public TagTemplate.Builder clone()| Returns | |
|---|---|
| Type | Description |
TagTemplate.Builder |
|
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 |
|
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.
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];
| 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.
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];
| 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.
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];
| 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.
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 |
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 |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TagTemplate.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TagTemplate.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TagTemplate.Builder |
|
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.
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 |
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.
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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
TagTemplateField |
| Returns | |
|---|---|
| Type | Description |
TagTemplate.Builder |
|
putFieldsBuilderIfAbsent(String key)
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];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
TagTemplateField.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.
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 |
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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
StringThe 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 |
ByteStringThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TagTemplate.Builder |
|