Class Value (2.20.1)

Version 2.20.1

• 2.24.1 (latest)
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public final class Value extends GeneratedMessageV3 implements ValueOrBuilder

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

Protobuf type google.datastore.v1.Value

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Value

Implements

ValueOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ARRAY_VALUE_FIELD_NUMBER

public static final int ARRAY_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

BLOB_VALUE_FIELD_NUMBER

public static final int BLOB_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

DOUBLE_VALUE_FIELD_NUMBER

public static final int DOUBLE_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

ENTITY_VALUE_FIELD_NUMBER

public static final int ENTITY_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

EXCLUDE_FROM_INDEXES_FIELD_NUMBER

public static final int EXCLUDE_FROM_INDEXES_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

KEY_VALUE_FIELD_NUMBER

public static final int KEY_VALUE_FIELD_NUMBER

Field Value
Type	Description
int

MEANING_FIELD_NUMBER

public static final int MEANING_FIELD_NUMBER

Field Value
Type	Description
int

NULL_VALUE_FIELD_NUMBER

public static final int NULL_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

Overrides

AbstractMessage.equals(Object other)

getArrayValue()

public ArrayValue getArrayValue()

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

.google.datastore.v1.ArrayValue array_value = 9;

Returns
Type	Description
ArrayValue	The arrayValue.

getArrayValueOrBuilder()

public ArrayValueOrBuilder getArrayValueOrBuilder()

An array value. Cannot contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

.google.datastore.v1.ArrayValue array_value = 9;

Returns
Type	Description
ArrayValueOrBuilder

getBlobValue()

public ByteString getBlobValue()

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

bytes blob_value = 18;

Returns
Type	Description
ByteString	The blobValue.

getBooleanValue()

public boolean getBooleanValue()

A boolean value.

bool boolean_value = 1;

Returns
Type	Description
boolean	The booleanValue.

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.

getEntityValue()

public Entity getEntityValue()

An entity value.

• May have no key.
• May have a key with an incomplete key path.
• May have a reserved/read-only key.

.google.datastore.v1.Entity entity_value = 6;

Returns
Type	Description
Entity	The entityValue.

getEntityValueOrBuilder()

public EntityOrBuilder getEntityValueOrBuilder()

An entity value.

• May have no key.
• May have a key with an incomplete key path.
• May have a reserved/read-only key.

.google.datastore.v1.Entity entity_value = 6;

Returns
Type	Description
EntityOrBuilder

getExcludeFromIndexes()

public boolean getExcludeFromIndexes()

If the value should be excluded from all indexes including those defined explicitly.

bool exclude_from_indexes = 19;

Returns
Type	Description
boolean	The excludeFromIndexes.

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.

getKeyValue()

public Key getKeyValue()

A key value.

.google.datastore.v1.Key key_value = 5;

Returns
Type	Description
Key	The keyValue.

getKeyValueOrBuilder()

public KeyOrBuilder getKeyValueOrBuilder()

A key value.

.google.datastore.v1.Key key_value = 5;

Returns
Type	Description
KeyOrBuilder

getMeaning()

public int getMeaning()

The meaning field should only be populated for backwards compatibility.

int32 meaning = 14;

Returns
Type	Description
int	The meaning.

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>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStringValue()

public String getStringValue()

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

string string_value = 17;

Returns
Type	Description
String	The stringValue.

getStringValueBytes()

public ByteString getStringValueBytes()

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

string string_value = 17;

Returns
Type	Description
ByteString	The bytes for stringValue.

getTimestampValue()

public Timestamp getTimestampValue()

A timestamp value. When stored in the Datastore, precise only to microseconds; 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. When stored in the Datastore, precise only to microseconds; 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 contain another array value. A Value instance that sets field array_value must not set fields meaning or exclude_from_indexes.

.google.datastore.v1.ArrayValue array_value = 9;

Returns
Type	Description
boolean	Whether the arrayValue field is set.

hasBlobValue()

public boolean hasBlobValue()

A blob value. May have at most 1,000,000 bytes. When exclude_from_indexes is false, may have at most 1500 bytes. In JSON requests, must be base64-encoded.

bytes blob_value = 18;

Returns
Type	Description
boolean	Whether the blobValue field is set.

hasBooleanValue()

public boolean hasBooleanValue()

A boolean value.

bool boolean_value = 1;

Returns
Type	Description
boolean	Whether the booleanValue field is set.

hasDoubleValue()

public boolean hasDoubleValue()

A double value.

double double_value = 3;

Returns
Type	Description
boolean	Whether the doubleValue field is set.

hasEntityValue()

public boolean hasEntityValue()

An entity value.

• May have no key.
• May have a key with an incomplete key path.
• May have a reserved/read-only key.

.google.datastore.v1.Entity entity_value = 6;

Returns
Type	Description
boolean	Whether the entityValue 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.

hasKeyValue()

public boolean hasKeyValue()

A key value.

.google.datastore.v1.Key key_value = 5;

Returns
Type	Description
boolean	Whether the keyValue 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.

hasStringValue()

public boolean hasStringValue()

A UTF-8 encoded string value. When exclude_from_indexes is false (it is indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.

string string_value = 17;

Returns
Type	Description
boolean	Whether the stringValue field is set.

hasTimestampValue()

public boolean hasTimestampValue()

A timestamp value. When stored in the Datastore, precise only to microseconds; 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

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Value.Builder toBuilder()

Returns
Type	Description
Value.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException