com.google.api.services.spanner.v1

Class Spanner.Projects.Instances.Databases.Sessions.PartitionQuery

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<PartitionResponse>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Spanner.Projects.Instances.Databases.Sessions

public class Spanner.Projects.Instances.Databases.Sessions.PartitionQuery
extends SpannerRequest<PartitionResponse>

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	PartitionQuery(String session, PartitionQueryRequest content) Creates a set of partition tokens that can be used to execute a query operation in parallel.

Method Summary

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

PartitionQuery

protected PartitionQuery(String session,
                         PartitionQueryRequest content)

Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the `PartitionQueryRequest` used to create the partition tokens and the `ExecuteSqlRequests` that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it isn't possible to resume the query, and the whole operation must be restarted from the beginning. Create a request for the method "sessions.partitionQuery". 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.

PartitionQuery#initialize(com.google.api.client.googleapis.services.AbstractGoogleCl ientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

session - Required. The session used to create the partitions.

content - the PartitionQueryRequest

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: SpannerRequest

V1 error format.

Overrides:

set$Xgafv in class SpannerRequest<PartitionResponse>

setAccessToken

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

Description copied from class: SpannerRequest

OAuth access token.

Overrides:

setAccessToken in class SpannerRequest<PartitionResponse>

setAlt

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

Description copied from class: SpannerRequest

Data format for response.

Overrides:

setAlt in class SpannerRequest<PartitionResponse>

setCallback

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

Description copied from class: SpannerRequest

JSONP

Overrides:

setCallback in class SpannerRequest<PartitionResponse>

setFields

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

Description copied from class: SpannerRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class SpannerRequest<PartitionResponse>

setKey

public Spanner.Projects.Instances.Databases.Sessions.PartitionQuery 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<PartitionResponse>

setOauthToken

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

Description copied from class: SpannerRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class SpannerRequest<PartitionResponse>

setPrettyPrint

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

Description copied from class: SpannerRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class SpannerRequest<PartitionResponse>

setQuotaUser

public Spanner.Projects.Instances.Databases.Sessions.PartitionQuery 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<PartitionResponse>

setUploadType

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

Description copied from class: SpannerRequest

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

Overrides:

setUploadType in class SpannerRequest<PartitionResponse>

setUploadProtocol

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

Description copied from class: SpannerRequest

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

Overrides:

setUploadProtocol in class SpannerRequest<PartitionResponse>

getSession

public String getSession()

Required. The session used to create the partitions.

setSession

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

Required. The session used to create the partitions.

set

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

Overrides:

set in class SpannerRequest<PartitionResponse>