com.google.api.services.spanner.v1.model

Class ResultSet

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.ResultSet

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class ResultSet
extends com.google.api.client.json.GenericJson

Results from Read or ExecuteSql.

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
ResultSet()

Method Summary

Modifier and Type	Method and Description
ResultSet	clone()
ResultSetMetadata	getMetadata() Metadata about the result set, such as row type information.
MultiplexedSessionPrecommitToken	getPrecommitToken() Optional.
List<List<Object>>	getRows() Each element in `rows` is a row whose format is defined by metadata.row_type.
ResultSetStats	getStats() Query plan and execution statistics for the SQL statement that produced this result set.
ResultSet	set(String fieldName, Object value)
ResultSet	setMetadata(ResultSetMetadata metadata) Metadata about the result set, such as row type information.
ResultSet	setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken) Optional.
ResultSet	setRows(List<List<Object>> rows) Each element in `rows` is a row whose format is defined by metadata.row_type.
ResultSet	setStats(ResultSetStats stats) Query plan and execution statistics for the SQL statement that produced this result set.

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

ResultSet

public ResultSet()

Method Detail

getMetadata

public ResultSetMetadata getMetadata()

Metadata about the result set, such as row type information.

Returns:

value or null for none

setMetadata

public ResultSet setMetadata(ResultSetMetadata metadata)

Metadata about the result set, such as row type information.

Parameters:

metadata - metadata or null for none

getPrecommitToken

public MultiplexedSessionPrecommitToken getPrecommitToken()

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. 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 ResultSet setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)

Optional. A precommit token is included if the read-write transaction is on a multiplexed session. 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

getRows

public List<List<Object>> getRows()

Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

Returns:

value or null for none

setRows

public ResultSet setRows(List<List<Object>> rows)

Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here.

Parameters:

rows - rows or null for none

getStats

public ResultSetStats getStats()

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

Returns:

value or null for none

setStats

public ResultSet setStats(ResultSetStats stats)

Query plan and execution statistics for the SQL statement that produced this result set. These can be requested by setting ExecuteSqlRequest.query_mode. DML statements always produce stats containing the number of rows modified, unless executed using the ExecuteSqlRequest.QueryMode.PLAN ExecuteSqlRequest.query_mode. Other fields might or might not be populated, based on the ExecuteSqlRequest.query_mode.

Parameters:

stats - stats or null for none

set

public ResultSet set(String fieldName,
                     Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ResultSet clone()

Overrides:

clone in class com.google.api.client.json.GenericJson