Cloud Firestore V1 Client - Class CommitRequest (1.40.0)

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

The request for Firestore.Commit.

Generated from protobuf message google.firestore.v1.CommitRequest

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}.

↳ writes array<Google\Cloud\Firestore\V1\Write>

The writes to apply. Always executed atomically and in order.

↳ transaction string

If set, applies all writes in this transaction, and commits it.

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

getWrites

The writes to apply.

Always executed atomically and in order.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setWrites

The writes to apply.

Always executed atomically and in order.

Parameter
NameDescription
var array<Google\Cloud\Firestore\V1\Write>
Returns
TypeDescription
$this

getTransaction

If set, applies all writes in this transaction, and commits it.

Returns
TypeDescription
string

setTransaction

If set, applies all writes in this transaction, and commits it.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
database string

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

writes array<Google\Cloud\Firestore\V1\Write>

The writes to apply.

Always executed atomically and in order.

Returns
TypeDescription
Google\Cloud\Firestore\V1\CommitRequest