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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ database |
string
Required. The database name. In the format: |
↳ 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 | |
|---|---|
| Type | Description |
string |
|
setDatabase
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOptions
The options for the transaction.
Defaults to a read-write transaction.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\TransactionOptions|null |
|
hasOptions
clearOptions
setOptions
The options for the transaction.
Defaults to a read-write transaction.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\TransactionOptions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
database |
string
Required. The database name. In the format:
|
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\BeginTransactionRequest |
|