public static final class Tag.Builder extends GeneratedMessageV3.Builder<Tag.Builder> implements TagOrBuilderTags 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Tag.BuilderImplements
TagOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Tag.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
build()
public Tag build()| Returns | |
|---|---|
| Type | Description |
Tag |
|
buildPartial()
public Tag buildPartial()| Returns | |
|---|---|
| Type | Description |
Tag |
|
clear()
public Tag.Builder clear()| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
clearColumn()
public Tag.Builder clearColumn()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 |
Tag.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Tag.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
clearFields()
public Tag.Builder clearFields()| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
clearName()
public Tag.Builder clearName()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 |
Tag.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Tag.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
clearScope()
public Tag.Builder clearScope()| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
clearTemplate()
public Tag.Builder clearTemplate()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 |
Tag.Builder |
This builder for chaining. |
clearTemplateDisplayName()
public Tag.Builder clearTemplateDisplayName()Output only. The display name of the tag template.
string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
clone()
public Tag.Builder clone()| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getFields() (deprecated)
public Map<String,TagField> getFields()Use #getFieldsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,TagField> |
|
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];
| Returns | |
|---|---|
| Type | Description |
Map<String,TagField> |
|
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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
TagField |
| Returns | |
|---|---|
| Type | Description |
TagField |
|
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 |
| Returns | |
|---|---|
| Type | Description |
TagField |
|
getMutableFields() (deprecated)
public Map<String,TagField> getMutableFields()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,TagField> |
|
getName()
public 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. |
getScopeCase()
public Tag.ScopeCase getScopeCase()| Returns | |
|---|---|
| Type | Description |
Tag.ScopeCase |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(Tag other)
public Tag.Builder mergeFrom(Tag other)| Parameter | |
|---|---|
| Name | Description |
other |
Tag |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Tag.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Tag.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Tag.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
putAllFields(Map<String,TagField> values)
public Tag.Builder putAllFields(Map<String,TagField> values)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 |
values |
Map<String,TagField> |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
putFields(String key, TagField value)
public Tag.Builder putFields(String key, TagField value)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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
value |
TagField |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
putFieldsBuilderIfAbsent(String key)
public TagField.Builder putFieldsBuilderIfAbsent(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 |
| Returns | |
|---|---|
| Type | Description |
TagField.Builder |
|
removeFields(String key)
public Tag.Builder removeFields(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 |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
setColumn(String value)
public Tag.Builder setColumn(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe column to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setColumnBytes(ByteString value)
public Tag.Builder setColumnBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for column to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Tag.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
setName(String value)
public Tag.Builder setName(String value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Tag.Builder setNameBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Tag.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|
setTemplate(String value)
public Tag.Builder setTemplate(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe template to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setTemplateBytes(ByteString value)
public Tag.Builder setTemplateBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for template to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setTemplateDisplayName(String value)
public Tag.Builder setTemplateDisplayName(String value)Output only. The display name of the tag template.
string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe templateDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setTemplateDisplayNameBytes(ByteString value)
public Tag.Builder setTemplateDisplayNameBytes(ByteString value)Output only. The display name of the tag template.
string template_display_name = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for templateDisplayName to set. |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Tag.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Tag.Builder |
|