Class TagField (1.40.0)

public final class TagField extends GeneratedMessageV3 implements TagFieldOrBuilder

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

Protobuf type google.cloud.datacatalog.v1.TagField

Implements

TagFieldOrBuilder

Static Fields

BOOL_VALUE_FIELD_NUMBER

public static final int BOOL_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOUBLE_VALUE_FIELD_NUMBER

public static final int DOUBLE_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

ENUM_VALUE_FIELD_NUMBER

public static final int ENUM_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

ORDER_FIELD_NUMBER

public static final int ORDER_FIELD_NUMBER
Field Value
TypeDescription
int

RICHTEXT_VALUE_FIELD_NUMBER

public static final int RICHTEXT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

STRING_VALUE_FIELD_NUMBER

public static final int STRING_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

TIMESTAMP_VALUE_FIELD_NUMBER

public static final int TIMESTAMP_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TagField getDefaultInstance()
Returns
TypeDescription
TagField

getDescriptor()

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

newBuilder()

public static TagField.Builder newBuilder()
Returns
TypeDescription
TagField.Builder

newBuilder(TagField prototype)

public static TagField.Builder newBuilder(TagField prototype)
Parameter
NameDescription
prototypeTagField
Returns
TypeDescription
TagField.Builder

parseDelimitedFrom(InputStream input)

public static TagField parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TagField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TagField parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TagField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TagField parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TagField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TagField parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TagField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TagField parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TagField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TagField parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TagField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TagField
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TagField> parser()
Returns
TypeDescription
Parser<TagField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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

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.

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.

getParserForType()

public Parser<TagField> getParserForType()
Returns
TypeDescription
Parser<TagField>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TagField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TagField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException