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
provide permissions to create, edit, and use the template. For example,
see the TagTemplate User role
that includes a permission to use the tag template to tag resources.
Protobuf type google.cloud.datacatalog.v1.TagTemplate
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TagTemplate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public TagTemplate build()
Returns
buildPartial()
public TagTemplate buildPartial()
Returns
clear()
public TagTemplate.Builder clear()
Returns
Overrides
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;
clearField(Descriptors.FieldDescriptor field)
public TagTemplate.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearFields()
public TagTemplate.Builder clearFields()
Returns
clearIsPubliclyReadable()
public TagTemplate.Builder clearIsPubliclyReadable()
Indicates whether tags created with this template are public. Public tags
do not require tag template access to appear in
ListTags API response.
Additionally, you can search for a public tag by value with a
simple search query in addition to using a tag:
bool is_publicly_readable = 5;
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public TagTemplate.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public TagTemplate.Builder clone()
Returns
Overrides
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];
getDefaultInstanceForType()
public TagTemplate getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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;
| 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;
| Type | Description |
| ByteString | The bytes for displayName.
|
getFields()
public Map<String,TagTemplateField> getFields()
Returns
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];
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];
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];
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];
getIsPubliclyReadable()
public boolean getIsPubliclyReadable()
Indicates whether tags created with this template are public. Public tags
do not require tag template access to appear in
ListTags API response.
Additionally, you can search for a public tag by value with a
simple search query in addition to using a tag:
bool is_publicly_readable = 5;
| Type | Description |
| boolean | The isPubliclyReadable.
|
getMutableFields()
public Map<String,TagTemplateField> getMutableFields()
Use alternate mutation accessors instead.
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;
| 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;
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(TagTemplate other)
public TagTemplate.Builder mergeFrom(TagTemplate other)
Parameter
Returns
public TagTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public TagTemplate.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplate.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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];
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];
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];
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;
| Name | Description |
| value | String
The displayName to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for displayName to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public TagTemplate.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setIsPubliclyReadable(boolean value)
public TagTemplate.Builder setIsPubliclyReadable(boolean value)
Indicates whether tags created with this template are public. Public tags
do not require tag template access to appear in
ListTags API response.
Additionally, you can search for a public tag by value with a
simple search query in addition to using a tag:
bool is_publicly_readable = 5;
| Name | Description |
| value | boolean
The isPubliclyReadable to set.
|
Returns
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;
| Name | Description |
| value | String
The name to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TagTemplate.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final TagTemplate.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
