com.google.cloud.datacatalog.v1beta1

Interface TagTemplateOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

TagTemplate, TagTemplate.Builder

public interface TagTemplateOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsFields(String key) Required.
TagTemplate.DataplexTransferStatus	getDataplexTransferStatus() Output only.
int	getDataplexTransferStatusValue() Output only.
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.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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];

Returns:

The name.

getNameBytes

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];

Returns:

The bytes for name.

getDisplayName

String getDisplayName()

 The display name for this template. Defaults to an empty string.
 

string display_name = 2;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.ByteString getDisplayNameBytes()

 The display name for this template. Defaults to an empty string.
 

string display_name = 2;

Returns:

The bytes for displayName.

getFieldsCount

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];

containsFields

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];

getFields

@Deprecated
Map<String,TagTemplateField> getFields()

Deprecated.

Use getFieldsMap() instead.

getFieldsMap

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

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

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];

getDataplexTransferStatusValue

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:

The enum numeric value on the wire for dataplexTransferStatus.

getDataplexTransferStatus

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];

Returns:

The dataplexTransferStatus.