com.google.firestore.v1

Interface ValueOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Value, Value.Builder

public interface ValueOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ArrayValue	getArrayValue() An array value.
ArrayValueOrBuilder	getArrayValueOrBuilder() An array value.
boolean	getBooleanValue() A boolean value.
com.google.protobuf.ByteString	getBytesValue() A bytes value.
double	getDoubleValue() A double value.
com.google.type.LatLng	getGeoPointValue() A geo point value representing a point on the surface of Earth.
com.google.type.LatLngOrBuilder	getGeoPointValueOrBuilder() A geo point value representing a point on the surface of Earth.
long	getIntegerValue() An integer value.
MapValue	getMapValue() A map value.
MapValueOrBuilder	getMapValueOrBuilder() A map value.
com.google.protobuf.NullValue	getNullValue() A null value.
int	getNullValueValue() A null value.
String	getReferenceValue() A reference to a document.
com.google.protobuf.ByteString	getReferenceValueBytes() A reference to a document.
String	getStringValue() A string value.
com.google.protobuf.ByteString	getStringValueBytes() A string value.
com.google.protobuf.Timestamp	getTimestampValue() A timestamp value.
com.google.protobuf.TimestampOrBuilder	getTimestampValueOrBuilder() A timestamp value.
Value.ValueTypeCase	getValueTypeCase()
boolean	hasArrayValue() An array value.
boolean	hasBooleanValue() A boolean value.
boolean	hasBytesValue() A bytes value.
boolean	hasDoubleValue() A double value.
boolean	hasGeoPointValue() A geo point value representing a point on the surface of Earth.
boolean	hasIntegerValue() An integer value.
boolean	hasMapValue() A map value.
boolean	hasNullValue() A null value.
boolean	hasReferenceValue() A reference to a document.
boolean	hasStringValue() A string value.
boolean	hasTimestampValue() A timestamp value.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasNullValue

boolean hasNullValue()

 A null value.
 

.google.protobuf.NullValue null_value = 11;

Returns:

Whether the nullValue field is set.

getNullValueValue

int getNullValueValue()

 A null value.
 

.google.protobuf.NullValue null_value = 11;

Returns:

The enum numeric value on the wire for nullValue.

getNullValue

com.google.protobuf.NullValue getNullValue()

 A null value.
 

.google.protobuf.NullValue null_value = 11;

Returns:

The nullValue.

hasBooleanValue

boolean hasBooleanValue()

 A boolean value.
 

bool boolean_value = 1;

Returns:

Whether the booleanValue field is set.

getBooleanValue

boolean getBooleanValue()

 A boolean value.
 

bool boolean_value = 1;

Returns:

The booleanValue.

hasIntegerValue

boolean hasIntegerValue()

 An integer value.
 

int64 integer_value = 2;

Returns:

Whether the integerValue field is set.

getIntegerValue

long getIntegerValue()

 An integer value.
 

int64 integer_value = 2;

Returns:

The integerValue.

hasDoubleValue

boolean hasDoubleValue()

 A double value.
 

double double_value = 3;

Returns:

Whether the doubleValue field is set.

getDoubleValue

double getDoubleValue()

 A double value.
 

double double_value = 3;

Returns:

The doubleValue.

hasTimestampValue

boolean hasTimestampValue()

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

.google.protobuf.Timestamp timestamp_value = 10;

Returns:

Whether the timestampValue field is set.

getTimestampValue

com.google.protobuf.Timestamp getTimestampValue()

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

.google.protobuf.Timestamp timestamp_value = 10;

Returns:

The timestampValue.

getTimestampValueOrBuilder

com.google.protobuf.TimestampOrBuilder getTimestampValueOrBuilder()

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

.google.protobuf.Timestamp timestamp_value = 10;

hasStringValue

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:

Whether the stringValue field is set.

getStringValue

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:

The stringValue.

getStringValueBytes

com.google.protobuf.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:

The bytes for stringValue.

hasBytesValue

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:

Whether the bytesValue field is set.

getBytesValue

com.google.protobuf.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:

The bytesValue.

hasReferenceValue

boolean hasReferenceValue()

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

string reference_value = 5;

Returns:

Whether the referenceValue field is set.

getReferenceValue

String getReferenceValue()

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

string reference_value = 5;

Returns:

The referenceValue.

getReferenceValueBytes

com.google.protobuf.ByteString getReferenceValueBytes()

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

string reference_value = 5;

Returns:

The bytes for referenceValue.

hasGeoPointValue

boolean hasGeoPointValue()

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

.google.type.LatLng geo_point_value = 8;

Returns:

Whether the geoPointValue field is set.

getGeoPointValue

com.google.type.LatLng getGeoPointValue()

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

.google.type.LatLng geo_point_value = 8;

Returns:

The geoPointValue.

getGeoPointValueOrBuilder

com.google.type.LatLngOrBuilder getGeoPointValueOrBuilder()

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

.google.type.LatLng geo_point_value = 8;

hasArrayValue

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:

Whether the arrayValue field is set.

getArrayValue

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:

The arrayValue.

getArrayValueOrBuilder

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;

hasMapValue

boolean hasMapValue()

 A map value.
 

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

Returns:

Whether the mapValue field is set.

getMapValue

MapValue getMapValue()

 A map value.
 

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

Returns:

The mapValue.

getMapValueOrBuilder

MapValueOrBuilder getMapValueOrBuilder()

 A map value.
 

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

getValueTypeCase

Value.ValueTypeCase getValueTypeCase()