com.google.cloud.datacatalog.v1beta1

Interface TagOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Tag, Tag.Builder

public interface TagOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsFields(String key) Required.
String	getColumn() Resources like Entry can have schemas associated with them.
com.google.protobuf.ByteString	getColumnBytes() Resources like Entry can have schemas associated with them.
Map<String,TagField>	getFields() Deprecated.
int	getFieldsCount() Required.
Map<String,TagField>	getFieldsMap() Required.
TagField	getFieldsOrDefault(String key, TagField defaultValue) Required.
TagField	getFieldsOrThrow(String key) Required.
String	getName() Identifier.
com.google.protobuf.ByteString	getNameBytes() Identifier.
Tag.ScopeCase	getScopeCase()
String	getTemplate() Required.
com.google.protobuf.ByteString	getTemplateBytes() Required.
String	getTemplateDisplayName() Output only.
com.google.protobuf.ByteString	getTemplateDisplayNameBytes() Output only.
boolean	hasColumn() Resources like Entry can have schemas associated with them.

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 in URL format. Example:

 * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

 where `tag_id` is a system-generated identifier.
 Note that this Tag 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 in URL format. Example:

 * projects/{project_id}/locations/{location}/entrygroups/{entry_group_id}/entries/{entry_id}/tags/{tag_id}

 where `tag_id` is a system-generated identifier.
 Note that this Tag may not actually be stored in the location in this name.
 

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

Returns:

The bytes for name.

getTemplate

String getTemplate()

 Required. The resource name of the tag template that 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:

The template.

getTemplateBytes

com.google.protobuf.ByteString getTemplateBytes()

 Required. The resource name of the tag template that 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:

The bytes for template.

getTemplateDisplayName

String getTemplateDisplayName()

 Output only. The display name of the tag template.
 

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

Returns:

The templateDisplayName.

getTemplateDisplayNameBytes

com.google.protobuf.ByteString getTemplateDisplayNameBytes()

 Output only. The display name of the tag template.
 

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

Returns:

The bytes for templateDisplayName.

hasColumn

boolean hasColumn()

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

 For attaching a tag to a nested column, use `.` to separate the column
 names. Example:

 * `outer_column.inner_column`
 

string column = 4;

Returns:

Whether the column field is set.

getColumn

String getColumn()

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

 For attaching a tag to a nested column, use `.` to separate the column
 names. Example:

 * `outer_column.inner_column`
 

string column = 4;

Returns:

The column.

getColumnBytes

com.google.protobuf.ByteString getColumnBytes()

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

 For attaching a tag to a nested column, use `.` to separate the column
 names. Example:

 * `outer_column.inner_column`
 

string column = 4;

Returns:

The bytes for column.

getFieldsCount

int getFieldsCount()

 Required. This maps the ID of a tag field to the value of and additional
 information about that field. Valid field IDs are defined by the tag's
 template. A tag must have at least 1 field and at most 500 fields.
 

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

containsFields

boolean containsFields(String key)

 Required. This maps the ID of a tag field to the value of and additional
 information about that field. Valid field IDs are defined by the tag's
 template. A tag must have at least 1 field and at most 500 fields.
 

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

getFields

@Deprecated
Map<String,TagField> getFields()

Deprecated.

Use getFieldsMap() instead.

getFieldsMap

Map<String,TagField> getFieldsMap()

 Required. This maps the ID of a tag field to the value of and additional
 information about that field. Valid field IDs are defined by the tag's
 template. A tag must have at least 1 field and at most 500 fields.
 

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

getFieldsOrDefault

TagField getFieldsOrDefault(String key,
                            TagField defaultValue)

 Required. This maps the ID of a tag field to the value of and additional
 information about that field. Valid field IDs are defined by the tag's
 template. A tag must have at least 1 field and at most 500 fields.
 

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

getFieldsOrThrow

TagField getFieldsOrThrow(String key)

 Required. This maps the ID of a tag field to the value of and additional
 information about that field. Valid field IDs are defined by the tag's
 template. A tag must have at least 1 field and at most 500 fields.
 

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

getScopeCase

Tag.ScopeCase getScopeCase()