public final class Tag extends GeneratedMessageV3 implements TagOrBuilder
Tags contain custom metadata and are attached to Data Catalog resources. Tags
conform with the specification of their tag template.
See Data Catalog
IAM for information
on the permissions needed to create or view tags.
Protobuf type google.cloud.datacatalog.v1.Tag
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
COLUMN_FIELD_NUMBER
public static final int COLUMN_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TEMPLATE_DISPLAY_NAME_FIELD_NUMBER
public static final int TEMPLATE_DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TEMPLATE_FIELD_NUMBER
public static final int TEMPLATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Tag getDefaultInstance()
| Returns |
|---|
| Type | Description |
Tag | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Tag.Builder newBuilder()
newBuilder(Tag prototype)
public static Tag.Builder newBuilder(Tag prototype)
| Parameter |
|---|
| Name | Description |
prototype | Tag
|
public static Tag parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Tag | |
public static Tag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(byte[] data)
public static Tag parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(ByteString data)
public static Tag parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
public static Tag parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Tag | |
public static Tag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
public static Tag parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Tag | |
public static Tag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(ByteBuffer data)
public static Tag parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Tag | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Tag | |
parser()
public static Parser<Tag> parser()
Methods
containsFields(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getColumn()
public 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 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.
|
getDefaultInstanceForType()
public Tag getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Tag | |
getFields() (deprecated)
public Map<String,TagField> getFields()
getFieldsCount()
public 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 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];
getFieldsOrDefault(String key, TagField defaultValue)
public 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];
getFieldsOrThrow(String key)
public 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
|
getName()
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;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
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;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Tag> getParserForType()
Overrides
getScopeCase()
public Tag.ScopeCase getScopeCase()
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getTemplate()
public 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 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 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 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 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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Tag.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Tag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Tag.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
