Cloud Spanner V1 Client - Class BeginTransactionRequest (1.67.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class BeginTransactionRequest.

The request for BeginTransaction.

Generated from protobuf message google.spanner.v1.BeginTransactionRequest

Namespace

Google \ Cloud \ Spanner \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ session string

Required. The session in which the transaction runs.

↳ options Google\Cloud\Spanner\V1\TransactionOptions

Required. Options for the new transaction.

↳ request_options Google\Cloud\Spanner\V1\RequestOptions

Common options for this request. Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

getSession

Required. The session in which the transaction runs.

Returns
TypeDescription
string

setSession

Required. The session in which the transaction runs.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOptions

Required. Options for the new transaction.

Returns
TypeDescription
Google\Cloud\Spanner\V1\TransactionOptions|null

hasOptions

clearOptions

setOptions

Required. Options for the new transaction.

Parameter
NameDescription
var Google\Cloud\Spanner\V1\TransactionOptions
Returns
TypeDescription
$this

getRequestOptions

Common options for this request.

Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

Returns
TypeDescription
Google\Cloud\Spanner\V1\RequestOptions|null

hasRequestOptions

clearRequestOptions

setRequestOptions

Common options for this request.

Priority is ignored for this request. Setting the priority in this request_options struct will not do anything. To set the priority for a transaction, set it on the reads and writes that are part of this transaction instead.

Parameter
NameDescription
var Google\Cloud\Spanner\V1\RequestOptions
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
session string

Required. The session in which the transaction runs. Please see Google\Cloud\Spanner\V1\SpannerClient::sessionName() for help formatting this field.

options Google\Cloud\Spanner\V1\TransactionOptions

Required. Options for the new transaction.

Returns
TypeDescription
Google\Cloud\Spanner\V1\BeginTransactionRequest