Value (Cloud Datastore API v1beta3 (Rev. 90) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.datastore.v1beta3.model.Value

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Value
extends com.google.api.client.json.GenericJson
```
A message that can hold any of the supported value types and associated metadata.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Datastore API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Value()

Constructors
Constructor and Description
`Value()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Value`	`clone()`
`byte[]`	`decodeBlobValue()` A blob value.
`Value`	`encodeBlobValue(byte[] blobValue)` A blob value.
`ArrayValue`	`getArrayValue()` An array value.
`java.lang.String`	`getBlobValue()` A blob value.
`java.lang.Boolean`	`getBooleanValue()` A boolean value.
`java.lang.Double`	`getDoubleValue()` A double value.
`Entity`	`getEntityValue()` An entity value.
`java.lang.Boolean`	`getExcludeFromIndexes()` If the value should be excluded from all indexes including those defined explicitly.
`LatLng`	`getGeoPointValue()` A geo point value representing a point on the surface of Earth.
`java.lang.Long`	`getIntegerValue()` An integer value.
`Key`	`getKeyValue()` A key value.
`java.lang.Integer`	`getMeaning()` The `meaning` field should only be populated for backwards compatibility.
`java.lang.String`	`getNullValue()` A null value.
`java.lang.String`	`getStringValue()` A UTF-8 encoded string value.
`java.lang.String`	`getTimestampValue()` A timestamp value.
`Value`	`set(java.lang.String fieldName, java.lang.Object value)`
`Value`	`setArrayValue(ArrayValue arrayValue)` An array value.
`Value`	`setBlobValue(java.lang.String blobValue)` A blob value.
`Value`	`setBooleanValue(java.lang.Boolean booleanValue)` A boolean value.
`Value`	`setDoubleValue(java.lang.Double doubleValue)` A double value.
`Value`	`setEntityValue(Entity entityValue)` An entity value.
`Value`	`setExcludeFromIndexes(java.lang.Boolean excludeFromIndexes)` If the value should be excluded from all indexes including those defined explicitly.
`Value`	`setGeoPointValue(LatLng geoPointValue)` A geo point value representing a point on the surface of Earth.
`Value`	`setIntegerValue(java.lang.Long integerValue)` An integer value.
`Value`	`setKeyValue(Key keyValue)` A key value.
`Value`	`setMeaning(java.lang.Integer meaning)` The `meaning` field should only be populated for backwards compatibility.
`Value`	`setNullValue(java.lang.String nullValue)` A null value.
`Value`	`setStringValue(java.lang.String stringValue)` A UTF-8 encoded string value.
`Value`	`setTimestampValue(java.lang.String timestampValue)` A timestamp value.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Value
```
public Value()
```
- Method Detail
  - 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`.
    
    Returns:
    
    value or null for none
  - setArrayValue
```
public Value setArrayValue(ArrayValue arrayValue)
```
    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`.
    
    Parameters:
    
    arrayValue - arrayValue or null for none
  - getBlobValue
```
public java.lang.String 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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeBlobValue()
  - decodeBlobValue
```
public byte[] decodeBlobValue()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getBlobValue()
  - setBlobValue
```
public Value setBlobValue(java.lang.String blobValue)
```
    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.
    
    Parameters:
    
    blobValue - blobValue or null for none
    
    See Also:
    
    #encodeBlobValue()
  - encodeBlobValue
```
public Value encodeBlobValue(byte[] blobValue)
```
    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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getBooleanValue
```
public java.lang.Boolean getBooleanValue()
```
    A boolean value.
    
    Returns:
    
    value or null for none
  - setBooleanValue
```
public Value setBooleanValue(java.lang.Boolean booleanValue)
```
    A boolean value.
    
    Parameters:
    
    booleanValue - booleanValue or null for none
  - getDoubleValue
```
public java.lang.Double getDoubleValue()
```
    A double value.
    
    Returns:
    
    value or null for none
  - setDoubleValue
```
public Value setDoubleValue(java.lang.Double doubleValue)
```
    A double value.
    
    Parameters:
    
    doubleValue - doubleValue or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setEntityValue
```
public Value setEntityValue(Entity entityValue)
```
    An entity value. - May have no key. - May have a key with an incomplete key path. - May have a reserved/read- only key.
    
    Parameters:
    
    entityValue - entityValue or null for none
  - getExcludeFromIndexes
```
public java.lang.Boolean getExcludeFromIndexes()
```
    If the value should be excluded from all indexes including those defined explicitly.
    
    Returns:
    
    value or null for none
  - setExcludeFromIndexes
```
public Value setExcludeFromIndexes(java.lang.Boolean excludeFromIndexes)
```
    If the value should be excluded from all indexes including those defined explicitly.
    
    Parameters:
    
    excludeFromIndexes - excludeFromIndexes or null for none
  - getGeoPointValue
```
public LatLng getGeoPointValue()
```
    A geo point value representing a point on the surface of Earth.
    
    Returns:
    
    value or null for none
  - setGeoPointValue
```
public Value setGeoPointValue(LatLng geoPointValue)
```
    A geo point value representing a point on the surface of Earth.
    
    Parameters:
    
    geoPointValue - geoPointValue or null for none
  - getIntegerValue
```
public java.lang.Long getIntegerValue()
```
    An integer value.
    
    Returns:
    
    value or null for none
  - setIntegerValue
```
public Value setIntegerValue(java.lang.Long integerValue)
```
    An integer value.
    
    Parameters:
    
    integerValue - integerValue or null for none
  - getKeyValue
```
public Key getKeyValue()
```
    A key value.
    
    Returns:
    
    value or null for none
  - setKeyValue
```
public Value setKeyValue(Key keyValue)
```
    A key value.
    
    Parameters:
    
    keyValue - keyValue or null for none
  - getMeaning
```
public java.lang.Integer getMeaning()
```
    The `meaning` field should only be populated for backwards compatibility.
    
    Returns:
    
    value or null for none
  - setMeaning
```
public Value setMeaning(java.lang.Integer meaning)
```
    The `meaning` field should only be populated for backwards compatibility.
    
    Parameters:
    
    meaning - meaning or null for none
  - getNullValue
```
public java.lang.String getNullValue()
```
    A null value.
    
    Returns:
    
    value or null for none
  - setNullValue
```
public Value setNullValue(java.lang.String nullValue)
```
    A null value.
    
    Parameters:
    
    nullValue - nullValue or null for none
  - getStringValue
```
public java.lang.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 least 1,000,000 bytes.
    
    Returns:
    
    value or null for none
  - setStringValue
```
public Value setStringValue(java.lang.String stringValue)
```
    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 least 1,000,000 bytes.
    
    Parameters:
    
    stringValue - stringValue or null for none
  - getTimestampValue
```
public java.lang.String getTimestampValue()
```
    A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
    
    Returns:
    
    value or null for none
  - setTimestampValue
```
public Value setTimestampValue(java.lang.String timestampValue)
```
    A timestamp value. When stored in the Datastore, precise only to microseconds; any additional precision is rounded down.
    
    Parameters:
    
    timestampValue - timestampValue or null for none
  - set
```
public Value set(java.lang.String fieldName,
                 java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Value clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Datastore API v1beta3 (revision 90)

Class Value

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Value

Method Detail

getArrayValue

setArrayValue

getBlobValue

decodeBlobValue

setBlobValue

encodeBlobValue

getBooleanValue

setBooleanValue

getDoubleValue

setDoubleValue

getEntityValue

setEntityValue

getExcludeFromIndexes

setExcludeFromIndexes

getGeoPointValue

setGeoPointValue

getIntegerValue

setIntegerValue

getKeyValue

setKeyValue

getMeaning

setMeaning

getNullValue

setNullValue

getStringValue

setStringValue

getTimestampValue

setTimestampValue

set

clone