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

Class ResultSetMetadata

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Metadata about a ResultSet or PartialResultSet.

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

Method Summary

Modifier and Type	Method and Description
ResultSetMetadata	clone()
StructType	getRowType() Indicates the field names and types for the rows in the result set.
Transaction	getTransaction() If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
StructType	getUndeclaredParameters() A SQL query can be parameterized.
ResultSetMetadata	set(String fieldName, Object value)
ResultSetMetadata	setRowType(StructType rowType) Indicates the field names and types for the rows in the result set.
ResultSetMetadata	setTransaction(Transaction transaction) If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
ResultSetMetadata	setUndeclaredParameters(StructType undeclaredParameters) A SQL query can be parameterized.

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

ResultSetMetadata

public ResultSetMetadata()

Method Detail

getRowType

public StructType getRowType()

Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]

Returns:

value or null for none

setRowType

public ResultSetMetadata setRowType(StructType rowType)

Indicates the field names and types for the rows in the result set. For example, a SQL query like `"SELECT UserId, UserName FROM Users"` could return a `row_type` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]

Parameters:

rowType - rowType or null for none

getTransaction

public Transaction getTransaction()

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

Returns:

value or null for none

setTransaction

public ResultSetMetadata setTransaction(Transaction transaction)

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

Parameters:

transaction - transaction or null for none

getUndeclaredParameters

public StructType getUndeclaredParameters()

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like `"SELECT * FROM Users where UserId = @userId and UserName = @userName "` could return a `undeclared_parameters` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]

Returns:

value or null for none

setUndeclaredParameters

public ResultSetMetadata setUndeclaredParameters(StructType undeclaredParameters)

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like `"SELECT * FROM Users where UserId = @userId and UserName = @userName "` could return a `undeclared_parameters` value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]

Parameters:

undeclaredParameters - undeclaredParameters or null for none

set

public ResultSetMetadata set(String fieldName,
                             Object value)

Overrides:

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

clone

public ResultSetMetadata clone()

Overrides:

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