public final class Value extends GeneratedMessageV3 implements ValueOrBuilderA message that can hold any of the supported value types.
Protobuf type google.firestore.v1.Value
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ValueImplements
ValueOrBuilderStatic Fields
ARRAY_VALUE_FIELD_NUMBER
public static final int ARRAY_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BOOLEAN_VALUE_FIELD_NUMBER
public static final int BOOLEAN_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
BYTES_VALUE_FIELD_NUMBER
public static final int BYTES_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DOUBLE_VALUE_FIELD_NUMBER
public static final int DOUBLE_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FIELD_REFERENCE_VALUE_FIELD_NUMBER
public static final int FIELD_REFERENCE_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FUNCTION_VALUE_FIELD_NUMBER
public static final int FUNCTION_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
GEO_POINT_VALUE_FIELD_NUMBER
public static final int GEO_POINT_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
INTEGER_VALUE_FIELD_NUMBER
public static final int INTEGER_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAP_VALUE_FIELD_NUMBER
public static final int MAP_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NULL_VALUE_FIELD_NUMBER
public static final int NULL_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PIPELINE_VALUE_FIELD_NUMBER
public static final int PIPELINE_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REFERENCE_VALUE_FIELD_NUMBER
public static final int REFERENCE_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
STRING_VALUE_FIELD_NUMBER
public static final int STRING_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TIMESTAMP_VALUE_FIELD_NUMBER
public static final int TIMESTAMP_VALUE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Value getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Value |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Value.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Value.Builder |
|
newBuilder(Value prototype)
public static Value.Builder newBuilder(Value prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Value |
| Returns | |
|---|---|
| Type | Description |
Value.Builder |
|
parseDelimitedFrom(InputStream input)
public static Value parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Value parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Value parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Value parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Value parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Value parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Value parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Value parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Value |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Value> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Value> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getArrayValue()
public ArrayValue getArrayValue()An array value.
Cannot directly contain another array value, though can contain a map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
ArrayValue |
The arrayValue. |
getArrayValueOrBuilder()
public ArrayValueOrBuilder getArrayValueOrBuilder()An array value.
Cannot directly contain another array value, though can contain a map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
ArrayValueOrBuilder |
|
getBooleanValue()
public boolean getBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytesValue. |
getDefaultInstanceForType()
public Value getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Value |
|
getDoubleValue()
public double getDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
double |
The doubleValue. |
getFieldReferenceValue()
public String getFieldReferenceValue()Value which references a field.
This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document.
Requires:
Must follow field reference limitations.
Not allowed to be used when writing documents.
string field_reference_value = 19;
| Returns | |
|---|---|
| Type | Description |
String |
The fieldReferenceValue. |
getFieldReferenceValueBytes()
public ByteString getFieldReferenceValueBytes()Value which references a field.
This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document.
Requires:
Must follow field reference limitations.
Not allowed to be used when writing documents.
string field_reference_value = 19;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for fieldReferenceValue. |
getFunctionValue()
public Function getFunctionValue()A value that represents an unevaluated expression.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Function function_value = 20;
| Returns | |
|---|---|
| Type | Description |
Function |
The functionValue. |
getFunctionValueOrBuilder()
public FunctionOrBuilder getFunctionValueOrBuilder()A value that represents an unevaluated expression.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Function function_value = 20;
| Returns | |
|---|---|
| Type | Description |
FunctionOrBuilder |
|
getGeoPointValue()
public LatLng getGeoPointValue()A geo point value representing a point on the surface of Earth.
.google.type.LatLng geo_point_value = 8;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
com.google.type.LatLngOrBuilder |
|
getIntegerValue()
public long getIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
long |
The integerValue. |
getMapValue()
public MapValue getMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValue |
The mapValue. |
getMapValueOrBuilder()
public MapValueOrBuilder getMapValueOrBuilder()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValueOrBuilder |
|
getNullValue()
public NullValue getNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
NullValue |
The nullValue. |
getNullValueValue()
public int getNullValueValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for nullValue. |
getParserForType()
public Parser<Value> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Value> |
|
getPipelineValue()
public Pipeline getPipelineValue()A value that represents an unevaluated pipeline.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Pipeline pipeline_value = 21;
| Returns | |
|---|---|
| Type | Description |
Pipeline |
The pipelineValue. |
getPipelineValueOrBuilder()
public PipelineOrBuilder getPipelineValueOrBuilder()A value that represents an unevaluated pipeline.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Pipeline pipeline_value = 21;
| Returns | |
|---|---|
| Type | Description |
PipelineOrBuilder |
|
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for referenceValue. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getValueTypeCase()
public Value.ValueTypeCase getValueTypeCase()| Returns | |
|---|---|
| Type | Description |
Value.ValueTypeCase |
|
hasArrayValue()
public boolean hasArrayValue()An array value.
Cannot directly contain another array value, though can contain a map which contains another array.
.google.firestore.v1.ArrayValue array_value = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the arrayValue field is set. |
hasBooleanValue()
public boolean hasBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the bytesValue field is set. |
hasDoubleValue()
public boolean hasDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the doubleValue field is set. |
hasFieldReferenceValue()
public boolean hasFieldReferenceValue()Value which references a field.
This is considered relative (vs absolute) since it only refers to a field and not a field within a particular document.
Requires:
Must follow field reference limitations.
Not allowed to be used when writing documents.
string field_reference_value = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fieldReferenceValue field is set. |
hasFunctionValue()
public boolean hasFunctionValue()A value that represents an unevaluated expression.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Function function_value = 20;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the functionValue 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 | |
|---|---|
| Type | Description |
boolean |
Whether the geoPointValue field is set. |
hasIntegerValue()
public boolean hasIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the integerValue field is set. |
hasMapValue()
public boolean hasMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mapValue field is set. |
hasNullValue()
public boolean hasNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the nullValue field is set. |
hasPipelineValue()
public boolean hasPipelineValue()A value that represents an unevaluated pipeline.
Requires:
- Not allowed to be used when writing documents.
.google.firestore.v1.Pipeline pipeline_value = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pipelineValue 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 | |
|---|---|
| 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;
| Returns | |
|---|---|
| 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;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timestampValue field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Value.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Value.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Value.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Value.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Value.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Value.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|