Interface TagOrBuilder (1.60.0)

Version latest

• 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 TagOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsFields(String key)

public abstract boolean containsFields(String key)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getColumn()

public abstract String getColumn()

Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
Type	Description
String	The column.

getColumnBytes()

public abstract ByteString getColumnBytes()

Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
Type	Description
ByteString	The bytes for column.

getFields() (deprecated)

public abstract Map<String,TagField> getFields()

Use #getFieldsMap() instead.

Returns
Type	Description
Map<String,TagField>

getFieldsCount()

public abstract int getFieldsCount()

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int

getFieldsMap()

public abstract Map<String,TagField> getFieldsMap()

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Map<String,TagField>

getFieldsOrDefault(String key, TagField defaultValue)

public abstract TagField getFieldsOrDefault(String key, TagField defaultValue)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
key	String
defaultValue	TagField

Returns
Type	Description
TagField

getFieldsOrThrow(String key)

public abstract TagField getFieldsOrThrow(String key)

Required. Maps the ID of a tag field to its value and additional information about that field.

Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields.

map<string, .google.cloud.datacatalog.v1.TagField> fields = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
key	String

Returns
Type	Description
TagField

getName()

public abstract String getName()

Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Identifier. The resource name of the tag in URL format where tag ID is a system-generated identifier.

Note: The tag itself might not be stored in the location specified in its name.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type	Description
ByteString	The bytes for name.

getScopeCase()

public abstract Tag.ScopeCase getScopeCase()

Returns
Type	Description
Tag.ScopeCase

getTemplate()

public abstract String getTemplate()

Required. The resource name of the tag template this tag uses. Example:

projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The template.

getTemplateBytes()

public abstract ByteString getTemplateBytes()

Required. The resource name of the tag template this tag uses. Example:

projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}

This field cannot be modified after creation.

string template = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for template.

getTemplateDisplayName()

public abstract String getTemplateDisplayName()

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The templateDisplayName.

getTemplateDisplayNameBytes()

public abstract ByteString getTemplateDisplayNameBytes()

Output only. The display name of the tag template.

string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for templateDisplayName.

hasColumn()

public abstract boolean hasColumn()

Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema.

To attach a tag to a nested column, separate column names with a dot (.). Example: column.nested_column.

string column = 4;

Returns
Type	Description
boolean	Whether the column field is set.