Class: Google::Cloud::Spanner::V1::CommitRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/v1/spanner.rb

Overview

The request for Commit.

Instance Attribute Summary collapse

Instance Attribute Details

#max_commit_delay ⇒ ::Google::Protobuf::Duration

Returns 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:

  • (::Google::Protobuf::Duration) —

    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.



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#mutations ⇒ ::Array<::Google::Cloud::Spanner::V1::Mutation>

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



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#precommit_token ⇒ ::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken

Returns 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:

  • (::Google::Cloud::Spanner::V1::MultiplexedSessionPrecommitToken) —

    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.



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#request_options ⇒ ::Google::Cloud::Spanner::V1::RequestOptions

Returns Common options for this request.

Returns:



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#return_commit_stats ⇒ ::Boolean

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

Returns:

  • (::Boolean) —

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



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#session ⇒ ::String

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



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#single_use_transaction ⇒ ::Google::Cloud::Spanner::V1::TransactionOptions

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

Note: The following fields are mutually exclusive: single_use_transaction, transaction_id. If a field in that set is populated, all other fields in the set will automatically be cleared.

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

    Note: The following fields are mutually exclusive: single_use_transaction, transaction_id. If a field in that set is populated, all other fields in the set will automatically be cleared.



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#transaction_id ⇒ ::String

Returns Commit a previously-started transaction.

Note: The following fields are mutually exclusive: transaction_id, single_use_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    Commit a previously-started transaction.

    Note: The following fields are mutually exclusive: transaction_id, single_use_transaction. If a field in that set is populated, all other fields in the set will automatically be cleared.



1074
1075
1076
1077
 
# File 'proto_docs/google/spanner/v1/spanner.rb', line 1074

class CommitRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end