Class TagField.Builder (1.40.0)

public static final class TagField.Builder extends GeneratedMessageV3.Builder<TagField.Builder> implements TagFieldOrBuilder

Contains the value and additional information on a field within a Tag.

Protobuf type google.cloud.datacatalog.v1.TagField

Implements

TagFieldOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TagField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TagField.Builder
Overrides

build()

public TagField build()
Returns
TypeDescription
TagField

buildPartial()

public TagField buildPartial()
Returns
TypeDescription
TagField

clear()

public TagField.Builder clear()
Returns
TypeDescription
TagField.Builder
Overrides

clearBoolValue()

public TagField.Builder clearBoolValue()

The value of a tag field with a boolean type.

bool bool_value = 4;

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearDisplayName()

public TagField.Builder clearDisplayName()

Output only. The display name of this field.

string display_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearDoubleValue()

public TagField.Builder clearDoubleValue()

The value of a tag field with a double type.

double double_value = 2;

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearEnumValue()

public TagField.Builder clearEnumValue()

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Returns
TypeDescription
TagField.Builder

clearField(Descriptors.FieldDescriptor field)

public TagField.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TagField.Builder
Overrides

clearKind()

public TagField.Builder clearKind()
Returns
TypeDescription
TagField.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public TagField.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
TagField.Builder
Overrides

clearOrder()

public TagField.Builder clearOrder()

Output only. The order of this field with respect to other fields in this tag. Can be set by Tag.

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.

int32 order = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearRichtextValue()

public TagField.Builder clearRichtextValue()

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearStringValue()

public TagField.Builder clearStringValue()

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Returns
TypeDescription
TagField.Builder

This builder for chaining.

clearTimestampValue()

public TagField.Builder clearTimestampValue()

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Returns
TypeDescription
TagField.Builder

clone()

public TagField.Builder clone()
Returns
TypeDescription
TagField.Builder
Overrides

getBoolValue()

public boolean getBoolValue()

The value of a tag field with a boolean type.

bool bool_value = 4;

Returns
TypeDescription
boolean

The boolValue.

getDefaultInstanceForType()

public TagField getDefaultInstanceForType()
Returns
TypeDescription
TagField

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Output only. The display name of this field.

string display_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Output only. The display name of this field.

string display_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for displayName.

getDoubleValue()

public double getDoubleValue()

The value of a tag field with a double type.

double double_value = 2;

Returns
TypeDescription
double

The doubleValue.

getEnumValue()

public TagField.EnumValue getEnumValue()

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Returns
TypeDescription
TagField.EnumValue

The enumValue.

getEnumValueBuilder()

public TagField.EnumValue.Builder getEnumValueBuilder()

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Returns
TypeDescription
TagField.EnumValue.Builder

getEnumValueOrBuilder()

public TagField.EnumValueOrBuilder getEnumValueOrBuilder()

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Returns
TypeDescription
TagField.EnumValueOrBuilder

getKindCase()

public TagField.KindCase getKindCase()
Returns
TypeDescription
TagField.KindCase

getOrder()

public int getOrder()

Output only. The order of this field with respect to other fields in this tag. Can be set by Tag.

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.

int32 order = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The order.

getRichtextValue()

public String getRichtextValue()

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Returns
TypeDescription
String

The richtextValue.

getRichtextValueBytes()

public ByteString getRichtextValueBytes()

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Returns
TypeDescription
ByteString

The bytes for richtextValue.

getStringValue()

public String getStringValue()

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Returns
TypeDescription
String

The stringValue.

getStringValueBytes()

public ByteString getStringValueBytes()

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Returns
TypeDescription
ByteString

The bytes for stringValue.

getTimestampValue()

public Timestamp getTimestampValue()

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Returns
TypeDescription
Timestamp

The timestampValue.

getTimestampValueBuilder()

public Timestamp.Builder getTimestampValueBuilder()

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Returns
TypeDescription
Builder

getTimestampValueOrBuilder()

public TimestampOrBuilder getTimestampValueOrBuilder()

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Returns
TypeDescription
TimestampOrBuilder

hasBoolValue()

public boolean hasBoolValue()

The value of a tag field with a boolean type.

bool bool_value = 4;

Returns
TypeDescription
boolean

Whether the boolValue field is set.

hasDoubleValue()

public boolean hasDoubleValue()

The value of a tag field with a double type.

double double_value = 2;

Returns
TypeDescription
boolean

Whether the doubleValue field is set.

hasEnumValue()

public boolean hasEnumValue()

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Returns
TypeDescription
boolean

Whether the enumValue field is set.

hasRichtextValue()

public boolean hasRichtextValue()

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Returns
TypeDescription
boolean

Whether the richtextValue field is set.

hasStringValue()

public boolean hasStringValue()

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Returns
TypeDescription
boolean

Whether the stringValue field is set.

hasTimestampValue()

public boolean hasTimestampValue()

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Returns
TypeDescription
boolean

Whether the timestampValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeEnumValue(TagField.EnumValue value)

public TagField.Builder mergeEnumValue(TagField.EnumValue value)

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Parameter
NameDescription
valueTagField.EnumValue
Returns
TypeDescription
TagField.Builder

mergeFrom(TagField other)

public TagField.Builder mergeFrom(TagField other)
Parameter
NameDescription
otherTagField
Returns
TypeDescription
TagField.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TagField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TagField.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
TagField.Builder
Overrides

mergeTimestampValue(Timestamp value)

public TagField.Builder mergeTimestampValue(Timestamp value)

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TagField.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TagField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TagField.Builder
Overrides

setBoolValue(boolean value)

public TagField.Builder setBoolValue(boolean value)

The value of a tag field with a boolean type.

bool bool_value = 4;

Parameter
NameDescription
valueboolean

The boolValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setDisplayName(String value)

public TagField.Builder setDisplayName(String value)

Output only. The display name of this field.

string display_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public TagField.Builder setDisplayNameBytes(ByteString value)

Output only. The display name of this field.

string display_name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setDoubleValue(double value)

public TagField.Builder setDoubleValue(double value)

The value of a tag field with a double type.

double double_value = 2;

Parameter
NameDescription
valuedouble

The doubleValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setEnumValue(TagField.EnumValue value)

public TagField.Builder setEnumValue(TagField.EnumValue value)

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Parameter
NameDescription
valueTagField.EnumValue
Returns
TypeDescription
TagField.Builder

setEnumValue(TagField.EnumValue.Builder builderForValue)

public TagField.Builder setEnumValue(TagField.EnumValue.Builder builderForValue)

The value of a tag field with an enum type.

This value must be one of the allowed values listed in this enum.

.google.cloud.datacatalog.v1.TagField.EnumValue enum_value = 6;

Parameter
NameDescription
builderForValueTagField.EnumValue.Builder
Returns
TypeDescription
TagField.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public TagField.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TagField.Builder
Overrides

setOrder(int value)

public TagField.Builder setOrder(int value)

Output only. The order of this field with respect to other fields in this tag. Can be set by Tag.

For example, a higher value can indicate a more important field. The value can be negative. Multiple fields can have the same order, and field orders within a tag don't have to be sequential.

int32 order = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The order to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TagField.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TagField.Builder
Overrides

setRichtextValue(String value)

public TagField.Builder setRichtextValue(String value)

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Parameter
NameDescription
valueString

The richtextValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setRichtextValueBytes(ByteString value)

public TagField.Builder setRichtextValueBytes(ByteString value)

The value of a tag field with a rich text type.

The maximum length is 10 MiB as this value holds HTML descriptions including encoded images. The maximum length of the text without images is 100 KiB.

string richtext_value = 8;

Parameter
NameDescription
valueByteString

The bytes for richtextValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setStringValue(String value)

public TagField.Builder setStringValue(String value)

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Parameter
NameDescription
valueString

The stringValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setStringValueBytes(ByteString value)

public TagField.Builder setStringValueBytes(ByteString value)

The value of a tag field with a string type.

The maximum length is 2000 UTF-8 characters.

string string_value = 3;

Parameter
NameDescription
valueByteString

The bytes for stringValue to set.

Returns
TypeDescription
TagField.Builder

This builder for chaining.

setTimestampValue(Timestamp value)

public TagField.Builder setTimestampValue(Timestamp value)

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
TagField.Builder

setTimestampValue(Timestamp.Builder builderForValue)

public TagField.Builder setTimestampValue(Timestamp.Builder builderForValue)

The value of a tag field with a timestamp type.

.google.protobuf.Timestamp timestamp_value = 5;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
TagField.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final TagField.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TagField.Builder
Overrides