com.google.cloud.datacatalog.v1beta1

Class Tag

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.datacatalog.v1beta1.Tag

All Implemented Interfaces:

TagOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Tag
extends com.google.protobuf.GeneratedMessageV3
implements TagOrBuilder

 Tags are used to attach custom metadata to Data Catalog resources. Tags
 conform to the specifications within their tag template.

 See [Data Catalog
 IAM](https://cloud.google.com/data-catalog/docs/concepts/iam) for information
 on the permissions needed to create or view tags.
 

Protobuf type google.cloud.datacatalog.v1beta1.Tag

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tag.Builder Tags are used to attach custom metadata to Data Catalog resources.
static class	Tag.ScopeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	COLUMN_FIELD_NUMBER
static int	FIELDS_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TEMPLATE_DISPLAY_NAME_FIELD_NUMBER
static int	TEMPLATE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsFields(String key) Required.
boolean	equals(Object obj)
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.
static Tag	getDefaultInstance()
Tag	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<Tag>	getParserForType()
Tag.ScopeCase	getScopeCase()
int	getSerializedSize()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapFieldReflectionAccessor	internalGetMapFieldReflection(int number)
boolean	isInitialized()
static Tag.Builder	newBuilder()
static Tag.Builder	newBuilder(Tag prototype)
Tag.Builder	newBuilderForType()
protected Tag.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Tag	parseDelimitedFrom(InputStream input)
static Tag	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tag	parseFrom(byte[] data)
static Tag	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tag	parseFrom(ByteBuffer data)
static Tag	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tag	parseFrom(com.google.protobuf.ByteString data)
static Tag	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tag	parseFrom(com.google.protobuf.CodedInputStream input)
static Tag	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tag	parseFrom(InputStream input)
static Tag	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Tag>	parser()
Tag.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

TEMPLATE_FIELD_NUMBER

public static final int TEMPLATE_FIELD_NUMBER

See Also:

Constant Field Values

TEMPLATE_DISPLAY_NAME_FIELD_NUMBER

public static final int TEMPLATE_DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

COLUMN_FIELD_NUMBER

public static final int COLUMN_FIELD_NUMBER

See Also:

Constant Field Values

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection

protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)

Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getScopeCase

public Tag.ScopeCase getScopeCase()

Specified by:

getScopeCase in interface TagOrBuilder

getName

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

Specified by:

getName in interface TagOrBuilder

Returns:

The name.

getNameBytes

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

Specified by:

getNameBytes in interface TagOrBuilder

Returns:

The bytes for name.

getTemplate

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

Specified by:

getTemplate in interface TagOrBuilder

Returns:

The template.

getTemplateBytes

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

Specified by:

getTemplateBytes in interface TagOrBuilder

Returns:

The bytes for template.

getTemplateDisplayName

public String getTemplateDisplayName()

 Output only. The display name of the tag template.
 

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

Specified by:

getTemplateDisplayName in interface TagOrBuilder

Returns:

The templateDisplayName.

getTemplateDisplayNameBytes

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

Specified by:

getTemplateDisplayNameBytes in interface TagOrBuilder

Returns:

The bytes for templateDisplayName.

hasColumn

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

Specified by:

hasColumn in interface TagOrBuilder

Returns:

Whether the column field is set.

getColumn

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

Specified by:

getColumn in interface TagOrBuilder

Returns:

The column.

getColumnBytes

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

Specified by:

getColumnBytes in interface TagOrBuilder

Returns:

The bytes for column.

getFieldsCount

public int getFieldsCount()

Description copied from interface: TagOrBuilder

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

Specified by:

getFieldsCount in interface TagOrBuilder

containsFields

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

Specified by:

containsFields in interface TagOrBuilder

getFields

@Deprecated
public Map<String,TagField> getFields()

Deprecated.

Use getFieldsMap() instead.

Specified by:

getFields in interface TagOrBuilder

getFieldsMap

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

Specified by:

getFieldsMap in interface TagOrBuilder

getFieldsOrDefault

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

Specified by:

getFieldsOrDefault in interface TagOrBuilder

getFieldsOrThrow

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

Specified by:

getFieldsOrThrow in interface TagOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Tag parseFrom(ByteBuffer data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(ByteBuffer data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(com.google.protobuf.ByteString data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(com.google.protobuf.ByteString data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(byte[] data)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(byte[] data,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tag parseFrom(InputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Tag parseFrom(InputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static Tag parseDelimitedFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Tag parseDelimitedFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseFrom

public static Tag parseFrom(com.google.protobuf.CodedInputStream input)
                     throws IOException

Throws:

IOException

parseFrom

public static Tag parseFrom(com.google.protobuf.CodedInputStream input,
                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                     throws IOException

Throws:

IOException

newBuilderForType

public Tag.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Tag.Builder newBuilder()

newBuilder

public static Tag.Builder newBuilder(Tag prototype)

toBuilder

public Tag.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Tag.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Tag getDefaultInstance()

parser

public static com.google.protobuf.Parser<Tag> parser()

getParserForType

public com.google.protobuf.Parser<Tag> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Tag getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder