Interface TagTemplateOrBuilder (1.6.2)

Version 1.6.2

• 1.60.0 (latest)
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public interface TagTemplateOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsFields(String key)

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

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getDisplayName()

public abstract 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

Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for displayName.

getFields()

public abstract Map<String,TagTemplateField> getFields()

Use #getFieldsMap() instead.

Returns

Type	Description
Map<String,TagTemplateField>

getFieldsCount()

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

Returns

Type	Description
int

getFieldsMap()

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

Returns

Type	Description
Map<String,TagTemplateField>

getFieldsOrDefault(String key, TagTemplateField defaultValue)

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

Parameters

Name	Description
key	String
defaultValue	TagTemplateField

Returns

Type	Description
TagTemplateField

getFieldsOrThrow(String key)

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

Parameter

Name	Description
key	String

Returns

Type	Description
TagTemplateField

getIsPubliclyReadable()

public abstract 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 Note: If an IAM domain restriction 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

Type	Description
boolean	The isPubliclyReadable.

getName()

public abstract 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

Type	Description
String	The name.

getNameBytes()

public abstract 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

Type	Description
ByteString	The bytes for name.