Class Value (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
public final class Value extends GeneratedMessageV3 implements ValueOrBuilder

A message that can hold any of the supported value types.

Protobuf type google.firestore.v1.Value

Implements

ValueOrBuilder

Static Fields

ARRAY_VALUE_FIELD_NUMBER

public static final int ARRAY_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

BOOLEAN_VALUE_FIELD_NUMBER

public static final int BOOLEAN_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

BYTES_VALUE_FIELD_NUMBER

public static final int BYTES_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

DOUBLE_VALUE_FIELD_NUMBER

public static final int DOUBLE_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

GEO_POINT_VALUE_FIELD_NUMBER

public static final int GEO_POINT_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

INTEGER_VALUE_FIELD_NUMBER

public static final int INTEGER_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

MAP_VALUE_FIELD_NUMBER

public static final int MAP_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

NULL_VALUE_FIELD_NUMBER

public static final int NULL_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

REFERENCE_VALUE_FIELD_NUMBER

public static final int REFERENCE_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 Value getDefaultInstance()
Returns
TypeDescription
Value

getDescriptor()

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

newBuilder()

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

newBuilder(Value prototype)

public static Value.Builder newBuilder(Value prototype)
Parameter
NameDescription
prototypeValue
Returns
TypeDescription
Value.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getArrayValue()

public ArrayValue getArrayValue()

An array value. Cannot directly contain another array value, though can contain an map which contains another array.

.google.firestore.v1.ArrayValue array_value = 9;

Returns
TypeDescription
ArrayValue

The arrayValue.

getArrayValueOrBuilder()

public ArrayValueOrBuilder getArrayValueOrBuilder()

An array value. Cannot directly contain another array value, though can contain an map which contains another array.

.google.firestore.v1.ArrayValue array_value = 9;

Returns
TypeDescription
ArrayValueOrBuilder

getBooleanValue()

public boolean getBooleanValue()

A boolean value.

bool boolean_value = 1;

Returns
TypeDescription
boolean

The booleanValue.

getBytesValue()

public ByteString getBytesValue()

A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

bytes bytes_value = 18;

Returns
TypeDescription
ByteString

The bytesValue.

getDefaultInstanceForType()

public Value getDefaultInstanceForType()
Returns
TypeDescription
Value

getDoubleValue()

public double getDoubleValue()

A double value.

double double_value = 3;

Returns
TypeDescription
double

The doubleValue.

getGeoPointValue()

public LatLng getGeoPointValue()

A geo point value representing a point on the surface of Earth.

.google.type.LatLng geo_point_value = 8;

Returns
TypeDescription
com.google.type.LatLng

The geoPointValue.

getGeoPointValueOrBuilder()

public LatLngOrBuilder getGeoPointValueOrBuilder()

A geo point value representing a point on the surface of Earth.

.google.type.LatLng geo_point_value = 8;

Returns
TypeDescription
com.google.type.LatLngOrBuilder

getIntegerValue()

public long getIntegerValue()

An integer value.

int64 integer_value = 2;

Returns
TypeDescription
long

The integerValue.

getMapValue()

public MapValue getMapValue()

A map value.

.google.firestore.v1.MapValue map_value = 6;

Returns
TypeDescription
MapValue

The mapValue.

getMapValueOrBuilder()

public MapValueOrBuilder getMapValueOrBuilder()

A map value.

.google.firestore.v1.MapValue map_value = 6;

Returns
TypeDescription
MapValueOrBuilder

getNullValue()

public NullValue getNullValue()

A null value.

.google.protobuf.NullValue null_value = 11;

Returns
TypeDescription
NullValue

The nullValue.

getNullValueValue()

public int getNullValueValue()

A null value.

.google.protobuf.NullValue null_value = 11;

Returns
TypeDescription
int

The enum numeric value on the wire for nullValue.

getParserForType()

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

getReferenceValue()

public String getReferenceValue()

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string reference_value = 5;

Returns
TypeDescription
String

The referenceValue.

getReferenceValueBytes()

public ByteString getReferenceValueBytes()

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string reference_value = 5;

Returns
TypeDescription
ByteString

The bytes for referenceValue.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStringValue()

public String getStringValue()

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

string string_value = 17;

Returns
TypeDescription
String

The stringValue.

getStringValueBytes()

public ByteString getStringValueBytes()

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

string string_value = 17;

Returns
TypeDescription
ByteString

The bytes for stringValue.

getTimestampValue()

public Timestamp getTimestampValue()

A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

.google.protobuf.Timestamp timestamp_value = 10;

Returns
TypeDescription
Timestamp

The timestampValue.

getTimestampValueOrBuilder()

public TimestampOrBuilder getTimestampValueOrBuilder()

A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

.google.protobuf.Timestamp timestamp_value = 10;

Returns
TypeDescription
TimestampOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValueTypeCase()

public Value.ValueTypeCase getValueTypeCase()
Returns
TypeDescription
Value.ValueTypeCase

hasArrayValue()

public boolean hasArrayValue()

An array value. Cannot directly contain another array value, though can contain an map which contains another array.

.google.firestore.v1.ArrayValue array_value = 9;

Returns
TypeDescription
boolean

Whether the arrayValue field is set.

hasBooleanValue()

public boolean hasBooleanValue()

A boolean value.

bool boolean_value = 1;

Returns
TypeDescription
boolean

Whether the booleanValue field is set.

hasBytesValue()

public boolean hasBytesValue()

A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.

bytes bytes_value = 18;

Returns
TypeDescription
boolean

Whether the bytesValue field is set.

hasDoubleValue()

public boolean hasDoubleValue()

A double value.

double double_value = 3;

Returns
TypeDescription
boolean

Whether the doubleValue field is set.

hasGeoPointValue()

public boolean hasGeoPointValue()

A geo point value representing a point on the surface of Earth.

.google.type.LatLng geo_point_value = 8;

Returns
TypeDescription
boolean

Whether the geoPointValue field is set.

hasIntegerValue()

public boolean hasIntegerValue()

An integer value.

int64 integer_value = 2;

Returns
TypeDescription
boolean

Whether the integerValue field is set.

hasMapValue()

public boolean hasMapValue()

A map value.

.google.firestore.v1.MapValue map_value = 6;

Returns
TypeDescription
boolean

Whether the mapValue field is set.

hasNullValue()

public boolean hasNullValue()

A null value.

.google.protobuf.NullValue null_value = 11;

Returns
TypeDescription
boolean

Whether the nullValue field is set.

hasReferenceValue()

public boolean hasReferenceValue()

A reference to a document. For example: projects/{project_id}/databases/{database_id}/documents/{document_path}.

string reference_value = 5;

Returns
TypeDescription
boolean

Whether the referenceValue field is set.

hasStringValue()

public boolean hasStringValue()

A string value. The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes of the UTF-8 representation are considered by queries.

string string_value = 17;

Returns
TypeDescription
boolean

Whether the stringValue field is set.

hasTimestampValue()

public boolean hasTimestampValue()

A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.

.google.protobuf.Timestamp timestamp_value = 10;

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 Value.Builder newBuilderForType()
Returns
TypeDescription
Value.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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