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
Static Fields
ARRAY_VALUE_FIELD_NUMBER
public static final int ARRAY_VALUE_FIELD_NUMBER
Field Value
BOOLEAN_VALUE_FIELD_NUMBER
public static final int BOOLEAN_VALUE_FIELD_NUMBER
Field Value
BYTES_VALUE_FIELD_NUMBER
public static final int BYTES_VALUE_FIELD_NUMBER
Field Value
DOUBLE_VALUE_FIELD_NUMBER
public static final int DOUBLE_VALUE_FIELD_NUMBER
Field Value
GEO_POINT_VALUE_FIELD_NUMBER
public static final int GEO_POINT_VALUE_FIELD_NUMBER
Field Value
INTEGER_VALUE_FIELD_NUMBER
public static final int INTEGER_VALUE_FIELD_NUMBER
Field Value
MAP_VALUE_FIELD_NUMBER
public static final int MAP_VALUE_FIELD_NUMBER
Field Value
NULL_VALUE_FIELD_NUMBER
public static final int NULL_VALUE_FIELD_NUMBER
Field Value
REFERENCE_VALUE_FIELD_NUMBER
public static final int REFERENCE_VALUE_FIELD_NUMBER
Field Value
STRING_VALUE_FIELD_NUMBER
public static final int STRING_VALUE_FIELD_NUMBER
Field Value
TIMESTAMP_VALUE_FIELD_NUMBER
public static final int TIMESTAMP_VALUE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Value getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Value.Builder newBuilder()
Returns
newBuilder(Value prototype)
public static Value.Builder newBuilder(Value prototype)
Parameter
| Name | Description |
| prototype | Value
|
Returns
public static Value parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Value parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Value parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Value parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Value parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Value parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Value parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Value parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Value parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Value> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
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;
getBooleanValue()
public boolean getBooleanValue()
A boolean value.
bool boolean_value = 1;
| Type | Description |
| 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;
getDefaultInstanceForType()
public Value getDefaultInstanceForType()
Returns
getDoubleValue()
public double getDoubleValue()
A double value.
double double_value = 3;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| com.google.type.LatLngOrBuilder | |
getIntegerValue()
public long getIntegerValue()
An integer value.
int64 integer_value = 2;
| Type | Description |
| long | The integerValue.
|
getMapValue()
public MapValue getMapValue()
A map value.
.google.firestore.v1.MapValue map_value = 6;
getMapValueOrBuilder()
public MapValueOrBuilder getMapValueOrBuilder()
A map value.
.google.firestore.v1.MapValue map_value = 6;
getNullValue()
public NullValue getNullValue()
A null value.
.google.protobuf.NullValue null_value = 11;
getNullValueValue()
public int getNullValueValue()
A null value.
.google.protobuf.NullValue null_value = 11;
| Type | Description |
| int | The enum numeric value on the wire for nullValue.
|
getParserForType()
public Parser<Value> getParserForType()
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for referenceValue.
|
getSerializedSize()
public int getSerializedSize()
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getValueTypeCase()
public Value.ValueTypeCase getValueTypeCase()
Returns
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;
| Type | Description |
| boolean | Whether the arrayValue field is set.
|
hasBooleanValue()
public boolean hasBooleanValue()
A boolean value.
bool boolean_value = 1;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the bytesValue field is set.
|
hasDoubleValue()
public boolean hasDoubleValue()
A double value.
double double_value = 3;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the geoPointValue field is set.
|
hasIntegerValue()
public boolean hasIntegerValue()
An integer value.
int64 integer_value = 2;
| Type | Description |
| boolean | Whether the integerValue field is set.
|
hasMapValue()
public boolean hasMapValue()
A map value.
.google.firestore.v1.MapValue map_value = 6;
| Type | Description |
| boolean | Whether the mapValue field is set.
|
hasNullValue()
public boolean hasNullValue()
A null value.
.google.protobuf.NullValue null_value = 11;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| boolean | Whether the timestampValue field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Value.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Value.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Value.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
