Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::BeginTransactionRequest (v1.15.0)

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

The request for BeginTransaction.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#mutation_key

def mutation_key() -> ::Google::Cloud::Spanner::V1::Mutation
Returns
  • (::Google::Cloud::Spanner::V1::Mutation) — Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

#mutation_key=

def mutation_key=(value) -> ::Google::Cloud::Spanner::V1::Mutation
Parameter
  • value (::Google::Cloud::Spanner::V1::Mutation) — Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.
Returns
  • (::Google::Cloud::Spanner::V1::Mutation) — Optional. Required for read-write transactions on a multiplexed session that commit mutations but don't perform any reads or queries. You must randomly select one of the mutations from the mutation set and send it as a part of this request.

#options

def options() -> ::Google::Cloud::Spanner::V1::TransactionOptions
Returns

#options=

def options=(value) -> ::Google::Cloud::Spanner::V1::TransactionOptions
Parameter
Returns

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions
Returns
  • (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions
Parameter
  • value (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.
Returns
  • (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct doesn't do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

#routing_hint

def routing_hint() -> ::Google::Cloud::Spanner::V1::RoutingHint
Returns
  • (::Google::Cloud::Spanner::V1::RoutingHint) — Optional. Makes the Spanner requests location-aware if present.

    It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

#routing_hint=

def routing_hint=(value) -> ::Google::Cloud::Spanner::V1::RoutingHint
Parameter
  • value (::Google::Cloud::Spanner::V1::RoutingHint) — Optional. Makes the Spanner requests location-aware if present.

    It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

Returns
  • (::Google::Cloud::Spanner::V1::RoutingHint) — Optional. Makes the Spanner requests location-aware if present.

    It gives the server hints that can be used to route the request to an appropriate server, potentially significantly decreasing latency and improving throughput. To achieve improved performance, most fields must be filled in with accurate values.

#session

def session() -> ::String
Returns
  • (::String) — Required. The session in which the transaction runs.

#session=

def session=(value) -> ::String
Parameter
  • value (::String) — Required. The session in which the transaction runs.
Returns
  • (::String) — Required. The session in which the transaction runs.