public final class TagTemplate extends GeneratedMessageV3 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 Fields
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
IS_PUBLICLY_READABLE_FIELD_NUMBER
public static final int IS_PUBLICLY_READABLE_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static TagTemplate getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static TagTemplate.Builder newBuilder()
Returns
newBuilder(TagTemplate prototype)
public static TagTemplate.Builder newBuilder(TagTemplate prototype)
Parameter
Returns
public static TagTemplate parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static TagTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static TagTemplate parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static TagTemplate parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TagTemplate parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static TagTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static TagTemplate parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static TagTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static TagTemplate parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<TagTemplate> parser()
Returns
Methods
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public TagTemplate getDefaultInstanceForType()
Returns
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.
|
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;
getParserForType()
public Parser<TagTemplate> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public TagTemplate.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TagTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public TagTemplate.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
