com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Databases.Sessions.Read

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.spanner.v1.SpannerRequest<ResultSet>

com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.Sessions.Read

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.Databases.Sessions

public class Spanner.Projects.Instances.Databases.Sessions.Read
extends SpannerRequest<ResultSet>

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>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Read(String session, ReadRequest content) Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql.

Method Summary

Modifier and Type	Method and Description
String	getSession() Required.
Spanner.Projects.Instances.Databases.Sessions.Read	set(String parameterName, Object value)
Spanner.Projects.Instances.Databases.Sessions.Read	set$Xgafv(String $Xgafv) V1 error format.
Spanner.Projects.Instances.Databases.Sessions.Read	setAccessToken(String accessToken) OAuth access token.
Spanner.Projects.Instances.Databases.Sessions.Read	setAlt(String alt) Data format for response.
Spanner.Projects.Instances.Databases.Sessions.Read	setCallback(String callback) JSONP
Spanner.Projects.Instances.Databases.Sessions.Read	setFields(String fields) Selector specifying which fields to include in a partial response.
Spanner.Projects.Instances.Databases.Sessions.Read	setKey(String key) API key.
Spanner.Projects.Instances.Databases.Sessions.Read	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Spanner.Projects.Instances.Databases.Sessions.Read	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Spanner.Projects.Instances.Databases.Sessions.Read	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Spanner.Projects.Instances.Databases.Sessions.Read	setSession(String session) Required.
Spanner.Projects.Instances.Databases.Sessions.Read	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Spanner.Projects.Instances.Databases.Sessions.Read	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.spanner.v1.SpannerRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

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

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

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

Read

protected Read(String session,
               ReadRequest content)

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method can't be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. Create a request for the method "sessions.read". This request holds the parameters needed by the the spanner server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Spanner.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

session - Required. The session in which the read should be performed.

content - the ReadRequest

Since:

1.13

Method Detail

set$Xgafv

public Spanner.Projects.Instances.Databases.Sessions.Read set$Xgafv(String $Xgafv)

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<ResultSet>

setAccessToken

public Spanner.Projects.Instances.Databases.Sessions.Read setAccessToken(String accessToken)

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<ResultSet>

setAlt

public Spanner.Projects.Instances.Databases.Sessions.Read setAlt(String alt)

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<ResultSet>

setCallback

public Spanner.Projects.Instances.Databases.Sessions.Read setCallback(String callback)

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<ResultSet>

setFields

public Spanner.Projects.Instances.Databases.Sessions.Read setFields(String fields)

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<ResultSet>

setKey

public Spanner.Projects.Instances.Databases.Sessions.Read setKey(String key)

Description copied from class: SpannerRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class SpannerRequest<ResultSet>

setOauthToken

public Spanner.Projects.Instances.Databases.Sessions.Read setOauthToken(String oauthToken)

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<ResultSet>

setPrettyPrint

public Spanner.Projects.Instances.Databases.Sessions.Read setPrettyPrint(Boolean prettyPrint)

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<ResultSet>

setQuotaUser

public Spanner.Projects.Instances.Databases.Sessions.Read setQuotaUser(String quotaUser)

Description copied from class: SpannerRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class SpannerRequest<ResultSet>

setUploadType

public Spanner.Projects.Instances.Databases.Sessions.Read setUploadType(String uploadType)

Description copied from class: SpannerRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class SpannerRequest<ResultSet>

setUploadProtocol

public Spanner.Projects.Instances.Databases.Sessions.Read setUploadProtocol(String uploadProtocol)

Description copied from class: SpannerRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class SpannerRequest<ResultSet>

getSession

public String getSession()

Required. The session in which the read should be performed.

setSession

public Spanner.Projects.Instances.Databases.Sessions.Read setSession(String session)

Required. The session in which the read should be performed.

set

public Spanner.Projects.Instances.Databases.Sessions.Read set(String parameterName,
                                                              Object value)

Overrides:

set in class SpannerRequest<ResultSet>