Cloud Firestore V1beta1 Client - Class TransactionOptions (1.40.0)

Version 1.40.0

• 1.47.0 (latest)
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Options for creating a new transaction.

Generated from protobuf message google.firestore.v1beta1.TransactionOptions

Namespace

Google \ Cloud \ Firestore \ V1beta1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ read_only	Google\Cloud\Firestore\V1beta1\TransactionOptions\PBReadOnly The transaction can only be used for read operations.
↳ read_write	Google\Cloud\Firestore\V1beta1\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\V1beta1\TransactionOptions\PBReadOnly|null

hasReadOnly

setReadOnly

The transaction can only be used for read operations.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\TransactionOptions\PBReadOnly

Returns
Type	Description
$this

getReadWrite

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

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

hasReadWrite

setReadWrite

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

Parameter
Name	Description
var	Google\Cloud\Firestore\V1beta1\TransactionOptions\ReadWrite

Returns
Type	Description
$this

getMode

Returns
Type	Description
string