PartialResultSet (Cloud Spanner API v1-rev20250708-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.spanner.v1.model.PartialResultSet

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class PartialResultSet
extends com.google.api.client.json.GenericJson
```
Partial results from a streaming read or SQL query. Streaming reads and SQL queries better tolerate large result sets, large rows, and large values, but are a little trickier to consume.
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 Spanner 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
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

PartialResultSet()

Constructors
Constructor and Description
`PartialResultSet()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PartialResultSet`	`clone()`
`byte[]`	`decodeResumeToken()` Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss.
`PartialResultSet`	`encodeResumeToken(byte[] resumeToken)` Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss.
`Boolean`	`getChunkedValue()` If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.
`Boolean`	`getLast()` Optional.
`ResultSetMetadata`	`getMetadata()` Metadata about the result set, such as row type information.
`MultiplexedSessionPrecommitToken`	`getPrecommitToken()` Optional.
`String`	`getResumeToken()` Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss.
`ResultSetStats`	`getStats()` Query plan and execution statistics for the statement that produced this streaming result set.
`List<Object>`	`getValues()` A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values.
`PartialResultSet`	`set(String fieldName, Object value)`
`PartialResultSet`	`setChunkedValue(Boolean chunkedValue)` If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.
`PartialResultSet`	`setLast(Boolean last)` Optional.
`PartialResultSet`	`setMetadata(ResultSetMetadata metadata)` Metadata about the result set, such as row type information.
`PartialResultSet`	`setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)` Optional.
`PartialResultSet`	`setResumeToken(String resumeToken)` Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss.
`PartialResultSet`	`setStats(ResultSetStats stats)` Query plan and execution statistics for the statement that produced this streaming result set.
`PartialResultSet`	`setValues(List<Object> values)` A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
  - PartialResultSet
```
public PartialResultSet()
```
- Method Detail
  - getChunkedValue
```
public Boolean getChunkedValue()
```
    If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.
    
    Returns:
    
    value or null for none
  - setChunkedValue
```
public PartialResultSet setChunkedValue(Boolean chunkedValue)
```
    If true, then the final value in values is chunked, and must be combined with more values from subsequent `PartialResultSet`s to obtain a complete field value.
    
    Parameters:
    
    chunkedValue - chunkedValue or null for none
  - getLast
```
public Boolean getLast()
```
    Optional. Indicates whether this is the last `PartialResultSet` in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases.
    
    Returns:
    
    value or null for none
  - setLast
```
public PartialResultSet setLast(Boolean last)
```
    Optional. Indicates whether this is the last `PartialResultSet` in the stream. The server might optionally set this field. Clients shouldn't rely on this field being set in all cases.
    
    Parameters:
    
    last - last or null for none
  - getMetadata
```
public ResultSetMetadata getMetadata()
```
    Metadata about the result set, such as row type information. Only present in the first response.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public PartialResultSet setMetadata(ResultSetMetadata metadata)
```
    Metadata about the result set, such as row type information. Only present in the first response.
    
    Parameters:
    
    metadata - metadata or null for none
  - getPrecommitToken
```
public MultiplexedSessionPrecommitToken getPrecommitToken()
```
    Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.
    
    Returns:
    
    value or null for none
  - setPrecommitToken
```
public PartialResultSet setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)
```
    Optional. A precommit token is included if the read-write transaction has multiplexed sessions enabled. Pass the precommit token with the highest sequence number from this transaction attempt to the Commit request for this transaction.
    
    Parameters:
    
    precommitToken - precommitToken or null for none
  - getResumeToken
```
public String getResumeToken()
```
    Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeResumeToken()
  - decodeResumeToken
```
public byte[] decodeResumeToken()
```
    Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getResumeToken()
  - setResumeToken
```
public PartialResultSet setResumeToken(String resumeToken)
```
    Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
    
    Parameters:
    
    resumeToken - resumeToken or null for none
    
    See Also:
    
    #encodeResumeToken()
  - encodeResumeToken
```
public PartialResultSet encodeResumeToken(byte[] resumeToken)
```
    Streaming calls might be interrupted for a variety of reasons, such as TCP connection loss. If this occurs, the stream of results can be resumed by re-sending the original request and including `resume_token`. Note that executing any other transaction in the same session invalidates the token.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getStats
```
public ResultSetStats getStats()
```
    Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements.
    
    Returns:
    
    value or null for none
  - setStats
```
public PartialResultSet setStats(ResultSetStats stats)
```
    Query plan and execution statistics for the statement that produced this streaming result set. These can be requested by setting ExecuteSqlRequest.query_mode and are sent only once with the last response in the stream. This field is also present in the last response for DML statements.
    
    Parameters:
    
    stats - stats or null for none
  - getValues
```
public List<Object> getValues()
```
    A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: Strings are concatenated. "foo", "bar" => "foobar" Lists of non- strings are concatenated. [2, 3], [4] => [2, 3, 4] Lists are concatenated, but the last and first elements are merged because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] Lists are concatenated, but the last and first elements are merged because they are lists. Recursively, the last and first elements of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` yields results from the `PartialResultSet` with value "orl".
    
    Returns:
    
    value or null for none
  - setValues
```
public PartialResultSet setValues(List<Object> values)
```
    A streamed result set consists of a stream of values, which might be split into many `PartialResultSet` messages to accommodate large rows and/or large values. Every N complete values defines a row, where N is equal to the number of entries in metadata.row_type.fields. Most values are encoded based on type as described here. It's possible that the last value in values is "chunked", meaning that the rest of the value is sent in subsequent `PartialResultSet`(s). This is denoted by the chunked_value field. Two or more chunked values can be merged to form a complete value as follows: * `bool/number/null`: can't be chunked * `string`: concatenate the strings * `list`: concatenate the lists. If the last element in a list is a `string`, `list`, or `object`, merge it with the first element in the next list by applying these rules recursively. * `object`: concatenate the (field name, field value) pairs. If a field name is duplicated, then apply these rules recursively to merge the field values. Some examples of merging: Strings are concatenated. "foo", "bar" => "foobar" Lists of non- strings are concatenated. [2, 3], [4] => [2, 3, 4] Lists are concatenated, but the last and first elements are merged because they are strings. ["a", "b"], ["c", "d"] => ["a", "bc", "d"] Lists are concatenated, but the last and first elements are merged because they are lists. Recursively, the last and first elements of the inner lists are merged because they are strings. ["a", ["b", "c"]], [["d"], "e"] => ["a", ["b", "cd"], "e"] Non-overlapping object fields are combined. {"a": "1"}, {"b": "2"} => {"a": "1", "b": 2"} Overlapping object fields are merged. {"a": "1"}, {"a": "2"} => {"a": "12"} Examples of merging objects containing lists of strings. {"a": ["1"]}, {"a": ["2"]} => {"a": ["12"]} For a more complete example, suppose a streaming SQL query is yielding a result set whose rows contain a single string field. The following `PartialResultSet`s might be yielded: { "metadata": { ... } "values": ["Hello", "W"] "chunked_value": true "resume_token": "Af65..." } { "values": ["orl"] "chunked_value": true } { "values": ["d"] "resume_token": "Zx1B..." } This sequence of `PartialResultSet`s encodes two rows, one containing the field value `"Hello"`, and a second containing the field value `"World" = "W" + "orl" + "d"`. Not all `PartialResultSet`s contain a `resume_token`. Execution can only be resumed from a previously yielded `resume_token`. For the above sequence of `PartialResultSet`s, resuming the query with `"resume_token": "Af65..."` yields results from the `PartialResultSet` with value "orl".
    
    Parameters:
    
    values - values or null for none
  - set
```
public PartialResultSet set(String fieldName,
                            Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public PartialResultSet clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class PartialResultSet

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

PartialResultSet

Method Detail

getChunkedValue

setChunkedValue

getLast

setLast

getMetadata

setMetadata

getPrecommitToken

setPrecommitToken

getResumeToken

decodeResumeToken

setResumeToken

encodeResumeToken

getStats

setStats

getValues

setValues

set

clone