com.google.firestore.v1beta1

Class Value

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1beta1.Value

All Implemented Interfaces:

ValueOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Value
extends GeneratedMessageV3
implements ValueOrBuilder

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

Protobuf type google.firestore.v1beta1.Value

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Value.Builder A message that can hold any of the supported value types.
static class	Value.ValueTypeCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARRAY_VALUE_FIELD_NUMBER
static int	BOOLEAN_VALUE_FIELD_NUMBER
static int	BYTES_VALUE_FIELD_NUMBER
static int	DOUBLE_VALUE_FIELD_NUMBER
static int	GEO_POINT_VALUE_FIELD_NUMBER
static int	INTEGER_VALUE_FIELD_NUMBER
static int	MAP_VALUE_FIELD_NUMBER
static int	NULL_VALUE_FIELD_NUMBER
static int	REFERENCE_VALUE_FIELD_NUMBER
static int	STRING_VALUE_FIELD_NUMBER
static int	TIMESTAMP_VALUE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
ArrayValue	getArrayValue() An array value.
ArrayValueOrBuilder	getArrayValueOrBuilder() An array value.
boolean	getBooleanValue() A boolean value.
ByteString	getBytesValue() A bytes value.
static Value	getDefaultInstance()
Value	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
double	getDoubleValue() A double value.
LatLng	getGeoPointValue() A geo point value representing a point on the surface of Earth.
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.
NullValue	getNullValue() A null value.
int	getNullValueValue() A null value.
Parser<Value>	getParserForType()
java.lang.String	getReferenceValue() A reference to a document.
ByteString	getReferenceValueBytes() A reference to a document.
int	getSerializedSize()
java.lang.String	getStringValue() A string value.
ByteString	getStringValueBytes() A string value.
Timestamp	getTimestampValue() A timestamp value.
TimestampOrBuilder	getTimestampValueOrBuilder() A timestamp value.
UnknownFieldSet	getUnknownFields()
Value.ValueTypeCase	getValueTypeCase()
boolean	hasArrayValue() An array value.
boolean	hasGeoPointValue() A geo point value representing a point on the surface of Earth.
int	hashCode()
boolean	hasMapValue() A map value.
boolean	hasTimestampValue() A timestamp value.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Value.Builder	newBuilder()
static Value.Builder	newBuilder(Value prototype)
Value.Builder	newBuilderForType()
protected Value.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Value	parseDelimitedFrom(java.io.InputStream input)
static Value	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Value	parseFrom(byte[] data)
static Value	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Value	parseFrom(java.nio.ByteBuffer data)
static Value	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Value	parseFrom(ByteString data)
static Value	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Value	parseFrom(CodedInputStream input)
static Value	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Value	parseFrom(java.io.InputStream input)
static Value	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Value>	parser()
Value.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NULL_VALUE_FIELD_NUMBER

public static final int NULL_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

BOOLEAN_VALUE_FIELD_NUMBER

public static final int BOOLEAN_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

INTEGER_VALUE_FIELD_NUMBER

public static final int INTEGER_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

DOUBLE_VALUE_FIELD_NUMBER

public static final int DOUBLE_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

TIMESTAMP_VALUE_FIELD_NUMBER

public static final int TIMESTAMP_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

STRING_VALUE_FIELD_NUMBER

public static final int STRING_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

BYTES_VALUE_FIELD_NUMBER

public static final int BYTES_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

REFERENCE_VALUE_FIELD_NUMBER

public static final int REFERENCE_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

GEO_POINT_VALUE_FIELD_NUMBER

public static final int GEO_POINT_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

ARRAY_VALUE_FIELD_NUMBER

public static final int ARRAY_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

MAP_VALUE_FIELD_NUMBER

public static final int MAP_VALUE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getValueTypeCase

public Value.ValueTypeCase getValueTypeCase()

Specified by:

getValueTypeCase in interface ValueOrBuilder

getNullValueValue

public int getNullValueValue()

 A null value.
 

.google.protobuf.NullValue null_value = 11;

Specified by:

getNullValueValue in interface ValueOrBuilder

getNullValue

public NullValue getNullValue()

 A null value.
 

.google.protobuf.NullValue null_value = 11;

Specified by:

getNullValue in interface ValueOrBuilder

getBooleanValue

public boolean getBooleanValue()

 A boolean value.
 

bool boolean_value = 1;

Specified by:

getBooleanValue in interface ValueOrBuilder

getIntegerValue

public long getIntegerValue()

 An integer value.
 

int64 integer_value = 2;

Specified by:

getIntegerValue in interface ValueOrBuilder

getDoubleValue

public double getDoubleValue()

 A double value.
 

double double_value = 3;

Specified by:

getDoubleValue in interface ValueOrBuilder

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;

Specified by:

hasTimestampValue in interface ValueOrBuilder

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;

Specified by:

getTimestampValue in interface ValueOrBuilder

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;

Specified by:

getTimestampValueOrBuilder in interface ValueOrBuilder

getStringValue

public java.lang.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;

Specified by:

getStringValue in interface ValueOrBuilder

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;

Specified by:

getStringValueBytes in interface ValueOrBuilder

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;

Specified by:

getBytesValue in interface ValueOrBuilder

getReferenceValue

public java.lang.String getReferenceValue()

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

string reference_value = 5;

Specified by:

getReferenceValue in interface ValueOrBuilder

getReferenceValueBytes

public ByteString getReferenceValueBytes()

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

string reference_value = 5;

Specified by:

getReferenceValueBytes in interface ValueOrBuilder

hasGeoPointValue

public boolean hasGeoPointValue()

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

.google.type.LatLng geo_point_value = 8;

Specified by:

hasGeoPointValue in interface ValueOrBuilder

getGeoPointValue

public LatLng getGeoPointValue()

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

.google.type.LatLng geo_point_value = 8;

Specified by:

getGeoPointValue in interface ValueOrBuilder

getGeoPointValueOrBuilder

public LatLngOrBuilder getGeoPointValueOrBuilder()

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

.google.type.LatLng geo_point_value = 8;

Specified by:

getGeoPointValueOrBuilder in interface ValueOrBuilder

hasArrayValue

public boolean hasArrayValue()

 An array value.
 Cannot contain another array value.
 

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

Specified by:

hasArrayValue in interface ValueOrBuilder

getArrayValue

public ArrayValue getArrayValue()

 An array value.
 Cannot contain another array value.
 

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

Specified by:

getArrayValue in interface ValueOrBuilder

getArrayValueOrBuilder

public ArrayValueOrBuilder getArrayValueOrBuilder()

 An array value.
 Cannot contain another array value.
 

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

Specified by:

getArrayValueOrBuilder in interface ValueOrBuilder

hasMapValue

public boolean hasMapValue()

 A map value.
 

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

Specified by:

hasMapValue in interface ValueOrBuilder

getMapValue

public MapValue getMapValue()

 A map value.
 

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

Specified by:

getMapValue in interface ValueOrBuilder

getMapValueOrBuilder

public MapValueOrBuilder getMapValueOrBuilder()

 A map value.
 

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

Specified by:

getMapValueOrBuilder in interface ValueOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Value parseFrom(java.nio.ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(java.nio.ByteBuffer data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(ByteString data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(byte[] data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Value parseFrom(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Value parseFrom(java.io.InputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Value parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Value parseDelimitedFrom(java.io.InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Value parseFrom(CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Value parseFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Value.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Value.Builder newBuilder()

newBuilder

public static Value.Builder newBuilder(Value prototype)

toBuilder

public Value.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Value.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Value getDefaultInstance()

parser

public static Parser<Value> parser()

getParserForType

public Parser<Value> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Value getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder