com.google.cloud.datacatalog

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() Required when used in [UpdateTagRequest][google.cloud.datacatalog.v1beta1.UpdateTagRequest].
com.google.protobuf.ByteString	getNameBytes() Required when used in [UpdateTagRequest][google.cloud.datacatalog.v1beta1.UpdateTagRequest].
Tag.ScopeCase	getScopeCase()
String	getTemplate() Required.
com.google.protobuf.ByteString	getTemplateBytes() Required.
String	getTemplateDisplayName() Output only.
com.google.protobuf.ByteString	getTemplateDisplayNameBytes() Output only.

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

 Required when used in
 [UpdateTagRequest][google.cloud.datacatalog.v1beta1.UpdateTagRequest]. The
 resource name of the tag in URL format. For 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;

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Required when used in
 [UpdateTagRequest][google.cloud.datacatalog.v1beta1.UpdateTagRequest]. The
 resource name of the tag in URL format. For 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;

getTemplate

String getTemplate()

 Required. The resource name of the tag template that this tag uses. For
 example,
 projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}.
 This field cannot be modified after creation.
 

string template = 2;

getTemplateBytes

com.google.protobuf.ByteString getTemplateBytes()

 Required. The resource name of the tag template that this tag uses. For
 example,
 projects/{project_id}/locations/{location}/tagTemplates/{tag_template_id}.
 This field cannot be modified after creation.
 

string template = 2;

getTemplateDisplayName

String getTemplateDisplayName()

 Output only. The display name of the tag template.
 

string template_display_name = 5;

getTemplateDisplayNameBytes

com.google.protobuf.ByteString getTemplateDisplayNameBytes()

 Output only. The display name of the tag template.
 

string template_display_name = 5;

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: "outer_column.inner_column".
 

string column = 4;

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: "outer_column.inner_column".
 

string column = 4;

getFieldsCount

int getFieldsCount()

 Required. This maps the id of a tag field to the value of & 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;

containsFields

boolean containsFields(String key)

 Required. This maps the id of a tag field to the value of & 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;

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

getFieldsOrDefault

TagField getFieldsOrDefault(String key,
                            TagField defaultValue)

 Required. This maps the id of a tag field to the value of & 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;

getFieldsOrThrow

TagField getFieldsOrThrow(String key)

 Required. This maps the id of a tag field to the value of & 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;

getScopeCase

Tag.ScopeCase getScopeCase()