target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.Sessions.PartitionRead.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Databases.Sessions.PartitionRead (Cloud Spanner API v1-rev20240910-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Databases.Sessions.PartitionRead
- 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.PartitionRead
-
- Enclosing class:
- Spanner.Projects.Instances.Databases.Sessions
public class Spanner.Projects.Instances.Databases.Sessions.PartitionRead
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected PartitionRead(String session,
PartitionReadRequest content)
Creates a set of partition tokens that can be used to execute a read operation in parallel.
-
Method Summary
-
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
-
PartitionRead
protected PartitionRead(String session,
PartitionReadRequest content)
Creates a set of partition tokens that can be used to execute a read operation in parallel.
Each of the returned partition tokens can be used by StreamingRead to specify a subset of the
read result to read. The same session and read-only transaction must be used by the
PartitionReadRequest used to create the partition tokens and the ReadRequests that use the
partition tokens. There are no ordering guarantees on rows returned among the returned
partition tokens, or even within each individual StreamingRead call issued with a
partition_token. 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 is not possible to resume the read, and the whole operation must be restarted from
the beginning.
Create a request for the method "sessions.partitionRead".
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.
PartitionRead#initialize(com.google.api.client.googleapis.services.AbstractGoogleClientR
equest) must be called to initialize this instance immediately after invoking the constructor.
- Parameters:
session - Required. The session used to create the partitions.content - the PartitionReadRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.Instances.Databases.Sessions.PartitionRead 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.PartitionRead setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<PartitionResponse>
-
setAlt
public Spanner.Projects.Instances.Databases.Sessions.PartitionRead 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.PartitionRead setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<PartitionResponse>
-
setFields
public Spanner.Projects.Instances.Databases.Sessions.PartitionRead 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.PartitionRead 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.PartitionRead 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.PartitionRead 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.PartitionRead 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.PartitionRead 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.PartitionRead 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.PartitionRead setSession(String session)
Required. The session used to create the partitions.
-
set
public Spanner.Projects.Instances.Databases.Sessions.PartitionRead set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<PartitionResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy