public final class TagTemplate extends GeneratedMessageV3 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
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DATAPLEX_TRANSFER_STATUS_FIELD_NUMBER
public static final int DATAPLEX_TRANSFER_STATUS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TagTemplate getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TagTemplate.Builder newBuilder()
newBuilder(TagTemplate prototype)
public static TagTemplate.Builder newBuilder(TagTemplate prototype)
public static TagTemplate parseDelimitedFrom(InputStream input)
public static TagTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TagTemplate parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TagTemplate parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(CodedInputStream input)
public static TagTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(InputStream input)
public static TagTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TagTemplate parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TagTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TagTemplate> parser()
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. 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for dataplexTransferStatus.
|
getDefaultInstanceForType()
public TagTemplate getDefaultInstanceForType()
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()
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];
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];
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
|
getName()
Identifier. The resource name of the tag template in URL format. Example:
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Identifier. The resource name of the tag template in URL format. Example:
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<TagTemplate> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TagTemplate.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TagTemplate.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public TagTemplate.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
