com.google.cloud.datacatalog.v1

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.
String	getDisplayName() Display name for this template.
com.google.protobuf.ByteString	getDisplayNameBytes() 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.
boolean	getIsPubliclyReadable() Indicates whether this is a public tag template.
String	getName() The resource name of the tag template in URL format.
com.google.protobuf.ByteString	getNameBytes() The resource name of the tag template in URL format.

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()

 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;

Returns:

The name.

getNameBytes

com.google.protobuf.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;

Returns:

The bytes for name.

getDisplayName

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;

Returns:

The displayName.

getDisplayNameBytes

com.google.protobuf.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;

Returns:

The bytes for displayName.

getIsPubliclyReadable

boolean getIsPubliclyReadable()

 Indicates whether this is a public tag template.
 Every user has view access to a *public* tag template by default.
 This means that:
   * Every user can use this tag template to tag an entry.
   * If an entry is tagged using the tag template, the tag is always
     shown in the response to ``ListTags`` called on the entry.
   * To get the template using the GetTagTemplate method, you
     need view access either on the project or the organization the tag
     template resides in but no other permission is needed.
   * Operations on the tag template other than viewing (for example,
     editing IAM policies) follow standard IAM structures.
 Tags created with a public tag template are referred to as public tags.
 You can search for a public tag by value with a
 simple search query instead of using a ``tag:`` predicate.
 Public tag templates may not appear in search results depending on scope,
 see:
 [include_public_tag_templates][google.cloud.datacatalog.v1.SearchCatalogRequest.Scope.include_public_tag_templates]
 Note: If an [IAM domain
 restriction](https://cloud.google.com/resource-manager/docs/organization-policy/restricting-domains)
 is configured in the tag template's location, the public access will not be
 enabled but the simple search for tag values will still work.
 

bool is_publicly_readable = 5;

Returns:

The isPubliclyReadable.

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

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

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. 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

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

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