Cloud Firestore V1 Client - Class BeginTransactionRequest (1.40.0)

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

The request for Firestore.BeginTransaction.

Generated from protobuf message google.firestore.v1.BeginTransactionRequest

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

↳ options Google\Cloud\Firestore\V1\TransactionOptions

The options for the transaction. Defaults to a read-write transaction.

getDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns
TypeDescription
string

setDatabase

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOptions

The options for the transaction.

Defaults to a read-write transaction.

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

hasOptions

clearOptions

setOptions

The options for the transaction.

Defaults to a read-write transaction.

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

static::build

Parameter
NameDescription
database string

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

Returns
TypeDescription
Google\Cloud\Firestore\V1\BeginTransactionRequest