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

Class CommitRequest

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

The request for Commit.

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

Method Summary

Modifier and Type	Method and Description
CommitRequest	clone()
byte[]	decodeTransactionId() Commit a previously-started transaction.
CommitRequest	encodeTransactionId(byte[] transactionId) Commit a previously-started transaction.
String	getMaxCommitDelay() Optional.
List<Mutation>	getMutations() The mutations to be executed when this transaction commits.
MultiplexedSessionPrecommitToken	getPrecommitToken() Optional.
RequestOptions	getRequestOptions() Common options for this request.
Boolean	getReturnCommitStats() If `true`, then statistics related to the transaction is included in the CommitResponse.
TransactionOptions	getSingleUseTransaction() Execute mutations in a temporary transaction.
String	getTransactionId() Commit a previously-started transaction.
CommitRequest	set(String fieldName, Object value)
CommitRequest	setMaxCommitDelay(String maxCommitDelay) Optional.
CommitRequest	setMutations(List<Mutation> mutations) The mutations to be executed when this transaction commits.
CommitRequest	setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken) Optional.
CommitRequest	setRequestOptions(RequestOptions requestOptions) Common options for this request.
CommitRequest	setReturnCommitStats(Boolean returnCommitStats) If `true`, then statistics related to the transaction is included in the CommitResponse.
CommitRequest	setSingleUseTransaction(TransactionOptions singleUseTransaction) Execute mutations in a temporary transaction.
CommitRequest	setTransactionId(String transactionId) Commit a previously-started transaction.

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

CommitRequest

public CommitRequest()

Method Detail

getMaxCommitDelay

public String getMaxCommitDelay()

Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms.

Returns:

value or null for none

setMaxCommitDelay

public CommitRequest setMaxCommitDelay(String maxCommitDelay)

Optional. The amount of latency this request is configured to incur in order to improve throughput. If this field isn't set, Spanner assumes requests are relatively latency sensitive and automatically determines an appropriate delay time. You can specify a commit delay value between 0 and 500 ms.

Parameters:

maxCommitDelay - maxCommitDelay or null for none

getMutations

public List<Mutation> getMutations()

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns:

value or null for none

setMutations

public CommitRequest setMutations(List<Mutation> mutations)

The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Parameters:

mutations - mutations or null for none

getPrecommitToken

public MultiplexedSessionPrecommitToken getPrecommitToken()

Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a `FailedPrecondition` error.

Returns:

value or null for none

setPrecommitToken

public CommitRequest setPrecommitToken(MultiplexedSessionPrecommitToken precommitToken)

Optional. If the read-write transaction was executed on a multiplexed session, then you must include the precommit token with the highest sequence number received in this transaction attempt. Failing to do so results in a `FailedPrecondition` error.

Parameters:

precommitToken - precommitToken or null for none

getRequestOptions

public RequestOptions getRequestOptions()

Common options for this request.

Returns:

value or null for none

setRequestOptions

public CommitRequest setRequestOptions(RequestOptions requestOptions)

Common options for this request.

Parameters:

requestOptions - requestOptions or null for none

getReturnCommitStats

public Boolean getReturnCommitStats()

If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`.

Returns:

value or null for none

setReturnCommitStats

public CommitRequest setReturnCommitStats(Boolean returnCommitStats)

If `true`, then statistics related to the transaction is included in the CommitResponse. Default value is `false`.

Parameters:

returnCommitStats - returnCommitStats or null for none

getSingleUseTransaction

public TransactionOptions getSingleUseTransaction()

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

Returns:

value or null for none

setSingleUseTransaction

public CommitRequest setSingleUseTransaction(TransactionOptions singleUseTransaction)

Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the `CommitRequest` is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it's possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

Parameters:

singleUseTransaction - singleUseTransaction or null for none

getTransactionId

public String getTransactionId()

Commit a previously-started transaction.

Returns:

value or null for none

See Also:

decodeTransactionId()

decodeTransactionId

public byte[] decodeTransactionId()

Commit a previously-started transaction.

Returns:

Base64 decoded value or null for none

Since:

1.14

See Also:

getTransactionId()

setTransactionId

public CommitRequest setTransactionId(String transactionId)

Commit a previously-started transaction.

Parameters:

transactionId - transactionId or null for none

See Also:

#encodeTransactionId()

encodeTransactionId

public CommitRequest encodeTransactionId(byte[] transactionId)

Commit a previously-started transaction.

Since:

1.14

See Also:

The value is encoded Base64 or {@code null} for none.

set

public CommitRequest set(String fieldName,
                         Object value)

Overrides:

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

clone

public CommitRequest clone()

Overrides:

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