public final class Tag extends 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 for information
on the permissions needed to create or view tags.
Protobuf type google.cloud.datacatalog.v1beta1.Tag
Static Fields
COLUMN_FIELD_NUMBER
public static final int COLUMN_FIELD_NUMBER
Field Value
FIELDS_FIELD_NUMBER
public static final int FIELDS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
TEMPLATE_DISPLAY_NAME_FIELD_NUMBER
public static final int TEMPLATE_DISPLAY_NAME_FIELD_NUMBER
Field Value
TEMPLATE_FIELD_NUMBER
public static final int TEMPLATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Tag getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Tag.Builder newBuilder()
Returns
newBuilder(Tag prototype)
public static Tag.Builder newBuilder(Tag prototype)
Parameter
| Name | Description |
| prototype | Tag
|
Returns
public static Tag parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Tag parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Tag parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Tag parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tag parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Tag parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Tag parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Tag parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Tag parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Tag parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Tag> parser()
Returns
Methods
containsFields(String key)
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];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
| String | The column.
|
getColumnBytes()
public 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;
getDefaultInstanceForType()
public Tag getDefaultInstanceForType()
Returns
getFields()
public Map<String,TagField> getFields()
Returns
getFieldsCount()
public 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];
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];
getFieldsOrDefault(String key, TagField defaultValue)
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];
getFieldsOrThrow(String key)
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];
getName()
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;
| Type | Description |
| String | The name.
|
getNameBytes()
public ByteString getNameBytes()
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;
getParserForType()
public Parser<Tag> getParserForType()
Returns
Overrides
getScopeCase()
public Tag.ScopeCase getScopeCase()
Returns
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
| Type | Description |
| String | The template.
|
getTemplateBytes()
public 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];
getTemplateDisplayName()
public String getTemplateDisplayName()
Output only. The display name of the tag template.
string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| Type | Description |
| ByteString | The bytes for templateDisplayName.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
| boolean | Whether the column field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Tag.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Tag.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Tag.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
