Cloud Firestore V1 Client - Class TransactionOptions (1.44.1)

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

Options for creating a new transaction.

Generated from protobuf message google.firestore.v1.TransactionOptions

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ read_only Google\Cloud\Firestore\V1\TransactionOptions\PBReadOnly

The transaction can only be used for read operations.
↳ read_write Google\Cloud\Firestore\V1\TransactionOptions\ReadWrite

The transaction can be used for both read and write operations.

getReadOnly

The transaction can only be used for read operations.

Returns
Type Description
Google\Cloud\Firestore\V1\TransactionOptions\PBReadOnly|null

hasReadOnly

setReadOnly

The transaction can only be used for read operations.

Parameter
Name Description
var Google\Cloud\Firestore\V1\TransactionOptions\PBReadOnly
Returns
Type Description
$this

getReadWrite

The transaction can be used for both read and write operations.

Returns
Type Description
Google\Cloud\Firestore\V1\TransactionOptions\ReadWrite|null

hasReadWrite

setReadWrite

The transaction can be used for both read and write operations.

Parameter
Name Description
var Google\Cloud\Firestore\V1\TransactionOptions\ReadWrite
Returns
Type Description
$this

getMode

Returns
Type Description
string