target.apidocs.com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.Sessions.BatchWrite.html Maven / Gradle / Ivy
Spanner.Projects.Instances.Databases.Sessions.BatchWrite (Cloud Spanner API v1-rev20240711-2.0.0)
com.google.api.services.spanner.v1
Class Spanner.Projects.Instances.Databases.Sessions.BatchWrite
- 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<BatchWriteResponse>
-
- com.google.api.services.spanner.v1.Spanner.Projects.Instances.Databases.Sessions.BatchWrite
-
- Enclosing class:
- Spanner.Projects.Instances.Databases.Sessions
public class Spanner.Projects.Instances.Databases.Sessions.BatchWrite
extends SpannerRequest<BatchWriteResponse>
-
-
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 BatchWrite(String session,
BatchWriteRequest content)
Batches the supplied mutation groups in a collection of efficient transactions.
-
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
-
BatchWrite
protected BatchWrite(String session,
BatchWriteRequest content)
Batches the supplied mutation groups in a collection of efficient transactions. All mutations
in a group are committed atomically. However, mutations across groups can be committed non-
atomically in an unspecified order and thus, they must be independent of each other. Partial
failure is possible, i.e., some groups may have been committed successfully, while some may
have failed. The results of individual batches are streamed into the response as the batches
are applied. BatchWrite requests are not replay protected, meaning that each mutation group may
be applied more than once. Replays of non-idempotent mutations may have undesirable effects.
For example, replays of an insert mutation may produce an already exists error or if you use
generated or commit timestamp-based keys, it may result in additional rows being added to the
mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this
issue.
Create a request for the method "sessions.batchWrite".
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 batch request is to be run.content - the BatchWriteRequest- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite set$Xgafv(String $Xgafv)
Description copied from class: SpannerRequest
V1 error format.
- Overrides:
set$Xgafv in class SpannerRequest<BatchWriteResponse>
-
setAccessToken
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setAccessToken(String accessToken)
Description copied from class: SpannerRequest
OAuth access token.
- Overrides:
setAccessToken in class SpannerRequest<BatchWriteResponse>
-
setAlt
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setAlt(String alt)
Description copied from class: SpannerRequest
Data format for response.
- Overrides:
setAlt in class SpannerRequest<BatchWriteResponse>
-
setCallback
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setCallback(String callback)
Description copied from class: SpannerRequest
JSONP
- Overrides:
setCallback in class SpannerRequest<BatchWriteResponse>
-
setFields
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setFields(String fields)
Description copied from class: SpannerRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields in class SpannerRequest<BatchWriteResponse>
-
setKey
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite 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<BatchWriteResponse>
-
setOauthToken
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setOauthToken(String oauthToken)
Description copied from class: SpannerRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken in class SpannerRequest<BatchWriteResponse>
-
setPrettyPrint
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setPrettyPrint(Boolean prettyPrint)
Description copied from class: SpannerRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint in class SpannerRequest<BatchWriteResponse>
-
setQuotaUser
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite 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<BatchWriteResponse>
-
setUploadType
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setUploadType(String uploadType)
Description copied from class: SpannerRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType in class SpannerRequest<BatchWriteResponse>
-
setUploadProtocol
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setUploadProtocol(String uploadProtocol)
Description copied from class: SpannerRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol in class SpannerRequest<BatchWriteResponse>
-
getSession
public String getSession()
Required. The session in which the batch request is to be run.
-
setSession
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite setSession(String session)
Required. The session in which the batch request is to be run.
-
set
public Spanner.Projects.Instances.Databases.Sessions.BatchWrite set(String parameterName,
Object value)
- Overrides:
set in class SpannerRequest<BatchWriteResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy