Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::CommitRequest (v1.3.0)

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::CommitRequest.

The request for Commit.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#max_commit_delay

def max_commit_delay() -> ::Google::Protobuf::Duration

Returns

(::Google::Protobuf::Duration) — 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.

#max_commit_delay=

def max_commit_delay=(value) -> ::Google::Protobuf::Duration

Parameter

value (::Google::Protobuf::Duration) — 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.

Returns

(::Google::Protobuf::Duration) — 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.

#mutations

def mutations() -> ::Array<::Google::Cloud::Spanner::V1::Mutation>

Returns

(::Array<::Google::Cloud::Spanner::V1::Mutation>) — The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

#mutations=

def mutations=(value) -> ::Array<::Google::Cloud::Spanner::V1::Mutation>

Parameter

value (::Array<::Google::Cloud::Spanner::V1::Mutation>) — The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

Returns

(::Array<::Google::Cloud::Spanner::V1::Mutation>) — The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list.

#precommit_token

def precommit_token() -> ::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken

Returns

(::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken) — Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.

#precommit_token=

def precommit_token=(value) -> ::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken

Parameter

value (::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken) — Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.

Returns

(::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken) — Optional. If the read-write transaction was executed on a multiplexed session, the precommit token with the highest sequence number received in this transaction attempt, should be included here. Failing to do so will result in a FailedPrecondition error. This feature is not yet supported and will result in an UNIMPLEMENTED error.

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions

Returns

(::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions

Parameter

value (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

Returns

(::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#return_commit_stats

def return_commit_stats() -> ::Boolean

Returns

(::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.

#return_commit_stats=

def return_commit_stats=(value) -> ::Boolean

Parameter

value (::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.

Returns

(::Boolean) — If true, then statistics related to the transaction will be included in the CommitResponse. Default value is false.

#session

def session() -> ::String

Returns

(::String) — Required. The session in which the transaction to be committed is running.

#session=

def session=(value) -> ::String

Parameter

value (::String) — Required. The session in which the transaction to be committed is running.

Returns

(::String) — Required. The session in which the transaction to be committed is running.

#single_use_transaction

def single_use_transaction() -> ::Google::Cloud::Spanner::V1::TransactionOptions

Returns

(::Google::Cloud::Spanner::V1::TransactionOptions) — 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.

#single_use_transaction=

def single_use_transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionOptions

Parameter

value (::Google::Cloud::Spanner::V1::TransactionOptions) — 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.

Returns

(::Google::Cloud::Spanner::V1::TransactionOptions) — 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.

#transaction_id

def transaction_id() -> ::String

Returns

(::String) — Commit a previously-started transaction.

#transaction_id=

def transaction_id=(value) -> ::String

Parameter

value (::String) — Commit a previously-started transaction.

Returns

(::String) — Commit a previously-started transaction.