public interface TagTemplateOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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() (deprecated)
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 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;
| 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. |