Interface CommitRequestOrBuilder (6.74.0)

public interface CommitRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMaxCommitDelay()

public abstract Duration getMaxCommitDelay()

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

.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The maxCommitDelay.

getMaxCommitDelayOrBuilder()

public abstract DurationOrBuilder getMaxCommitDelayOrBuilder()

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

.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getMutations(int index)

public abstract Mutation getMutations(int index)

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

repeated .google.spanner.v1.Mutation mutations = 4;

Parameter
Name Description
index int
Returns
Type Description
Mutation

getMutationsCount()

public abstract int getMutationsCount()

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

repeated .google.spanner.v1.Mutation mutations = 4;

Returns
Type Description
int

getMutationsList()

public abstract List<Mutation> getMutationsList()

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

repeated .google.spanner.v1.Mutation mutations = 4;

Returns
Type Description
List<Mutation>

getMutationsOrBuilder(int index)

public abstract MutationOrBuilder getMutationsOrBuilder(int index)

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

repeated .google.spanner.v1.Mutation mutations = 4;

Parameter
Name Description
index int
Returns
Type Description
MutationOrBuilder

getMutationsOrBuilderList()

public abstract List<? extends MutationOrBuilder> getMutationsOrBuilderList()

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

repeated .google.spanner.v1.Mutation mutations = 4;

Returns
Type Description
List<? extends com.google.spanner.v1.MutationOrBuilder>

getRequestOptions()

public abstract RequestOptions getRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 6;

Returns
Type Description
RequestOptions

The requestOptions.

getRequestOptionsOrBuilder()

public abstract RequestOptionsOrBuilder getRequestOptionsOrBuilder()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 6;

Returns
Type Description
RequestOptionsOrBuilder

getReturnCommitStats()

public abstract boolean getReturnCommitStats()

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

bool return_commit_stats = 5;

Returns
Type Description
boolean

The returnCommitStats.

getSession()

public abstract String getSession()

Required. The session in which the transaction to be committed is running.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The session.

getSessionBytes()

public abstract ByteString getSessionBytes()

Required. The session in which the transaction to be committed is running.

string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for session.

getSingleUseTransaction()

public abstract 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 is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

.google.spanner.v1.TransactionOptions single_use_transaction = 3;

Returns
Type Description
TransactionOptions

The singleUseTransaction.

getSingleUseTransactionOrBuilder()

public abstract TransactionOptionsOrBuilder getSingleUseTransactionOrBuilder()

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 is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

.google.spanner.v1.TransactionOptions single_use_transaction = 3;

Returns
Type Description
TransactionOptionsOrBuilder

getTransactionCase()

public abstract CommitRequest.TransactionCase getTransactionCase()
Returns
Type Description
CommitRequest.TransactionCase

getTransactionId()

public abstract ByteString getTransactionId()

Commit a previously-started transaction.

bytes transaction_id = 2;

Returns
Type Description
ByteString

The transactionId.

hasMaxCommitDelay()

public abstract boolean hasMaxCommitDelay()

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

.google.protobuf.Duration max_commit_delay = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxCommitDelay field is set.

hasRequestOptions()

public abstract boolean hasRequestOptions()

Common options for this request.

.google.spanner.v1.RequestOptions request_options = 6;

Returns
Type Description
boolean

Whether the requestOptions field is set.

hasSingleUseTransaction()

public abstract boolean hasSingleUseTransaction()

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 is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead.

.google.spanner.v1.TransactionOptions single_use_transaction = 3;

Returns
Type Description
boolean

Whether the singleUseTransaction field is set.

hasTransactionId()

public abstract boolean hasTransactionId()

Commit a previously-started transaction.

bytes transaction_id = 2;

Returns
Type Description
boolean

Whether the transactionId field is set.