public interface ValueOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getArrayValue()
public abstract 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 abstract 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 abstract boolean getBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
The booleanValue. |
getBytesValue()
public abstract 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. |
getDoubleValue()
public abstract double getDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
double |
The doubleValue. |
getFieldReferenceValue()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract long getIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
long |
The integerValue. |
getMapValue()
public abstract MapValue getMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValue |
The mapValue. |
getMapValueOrBuilder()
public abstract MapValueOrBuilder getMapValueOrBuilder()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
MapValueOrBuilder |
|
getNullValue()
public abstract NullValue getNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
NullValue |
The nullValue. |
getNullValueValue()
public abstract int getNullValueValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for nullValue. |
getPipelineValue()
public abstract 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 abstract 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 abstract 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 abstract 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. |
getStringValue()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract Value.ValueTypeCase getValueTypeCase()| Returns | |
|---|---|
| Type | Description |
Value.ValueTypeCase |
|
hasArrayValue()
public abstract 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 abstract boolean hasBooleanValue()A boolean value.
bool boolean_value = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the booleanValue field is set. |
hasBytesValue()
public abstract 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 abstract boolean hasDoubleValue()A double value.
double double_value = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the doubleValue field is set. |
hasFieldReferenceValue()
public abstract 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 abstract 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 abstract 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 abstract boolean hasIntegerValue()An integer value.
int64 integer_value = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the integerValue field is set. |
hasMapValue()
public abstract boolean hasMapValue()A map value.
.google.firestore.v1.MapValue map_value = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mapValue field is set. |
hasNullValue()
public abstract boolean hasNullValue()A null value.
.google.protobuf.NullValue null_value = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the nullValue field is set. |
hasPipelineValue()
public abstract 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 abstract 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 abstract 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 abstract 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. |