Value (Cloud Firestore API v1 (Rev. 25) 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.firestore.v1.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.
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 Firestore 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[]`	`decodeBytesValue()` A bytes value.
`Value`	`encodeBytesValue(byte[] bytesValue)` A bytes value.
`ArrayValue`	`getArrayValue()` An array value.
`java.lang.Boolean`	`getBooleanValue()` A boolean value.
`java.lang.String`	`getBytesValue()` A bytes value.
`java.lang.Double`	`getDoubleValue()` A double value.
`LatLng`	`getGeoPointValue()` A geo point value representing a point on the surface of Earth.
`java.lang.Long`	`getIntegerValue()` An integer value.
`MapValue`	`getMapValue()` A map value.
`java.lang.String`	`getNullValue()` A null value.
`java.lang.String`	`getReferenceValue()` A reference to a document.
`java.lang.String`	`getStringValue()` A 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`	`setBooleanValue(java.lang.Boolean booleanValue)` A boolean value.
`Value`	`setBytesValue(java.lang.String bytesValue)` A bytes value.
`Value`	`setDoubleValue(java.lang.Double doubleValue)` A double value.
`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`	`setMapValue(MapValue mapValue)` A map value.
`Value`	`setNullValue(java.lang.String nullValue)` A null value.
`Value`	`setReferenceValue(java.lang.String referenceValue)` A reference to a document.
`Value`	`setStringValue(java.lang.String stringValue)` A 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 directly contain another array value, though can contain an map which contains another array.
    
    Returns:
    
    value or null for none
  - setArrayValue
```
public Value setArrayValue(ArrayValue arrayValue)
```
    An array value. Cannot directly contain another array value, though can contain an map which contains another array.
    
    Parameters:
    
    arrayValue - arrayValue or 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
  - getBytesValue
```
public java.lang.String getBytesValue()
```
    A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeBytesValue()
  - decodeBytesValue
```
public byte[] decodeBytesValue()
```
    A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getBytesValue()
  - setBytesValue
```
public Value setBytesValue(java.lang.String bytesValue)
```
    A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
    
    Parameters:
    
    bytesValue - bytesValue or null for none
    
    See Also:
    
    #encodeBytesValue()
  - encodeBytesValue
```
public Value encodeBytesValue(byte[] bytesValue)
```
    A bytes value. Must not exceed 1 MiB - 89 bytes. Only the first 1,500 bytes are considered by queries.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code 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
  - 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
  - getMapValue
```
public MapValue getMapValue()
```
    A map value.
    
    Returns:
    
    value or null for none
  - setMapValue
```
public Value setMapValue(MapValue mapValue)
```
    A map value.
    
    Parameters:
    
    mapValue - mapValue 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
  - getReferenceValue
```
public java.lang.String getReferenceValue()
```
    A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    
    Returns:
    
    value or null for none
  - setReferenceValue
```
public Value setReferenceValue(java.lang.String referenceValue)
```
    A reference to a document. For example: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    
    Parameters:
    
    referenceValue - referenceValue or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setStringValue
```
public Value setStringValue(java.lang.String stringValue)
```
    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.
    
    Parameters:
    
    stringValue - stringValue or null for none
  - getTimestampValue
```
public java.lang.String getTimestampValue()
```
    A timestamp value. Precise only to microseconds. When stored, any additional precision is rounded down.
    
    Returns:
    
    value or null for none
  - setTimestampValue
```
public Value setTimestampValue(java.lang.String timestampValue)
```
    A timestamp value. Precise only to microseconds. When stored, 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 Firestore API v1 (revision 25)

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

getBooleanValue

setBooleanValue

getBytesValue

decodeBytesValue

setBytesValue

encodeBytesValue

getDoubleValue

setDoubleValue

getGeoPointValue

setGeoPointValue

getIntegerValue

setIntegerValue

getMapValue

setMapValue

getNullValue

setNullValue

getReferenceValue

setReferenceValue

getStringValue

setStringValue

getTimestampValue

setTimestampValue

set

clone