Cloud Firestore V1 Client - Class CommitRequest (1.44.1)

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
Name Description
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
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

getWrites

The writes to apply.

Always executed atomically and in order.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setWrites

The writes to apply.

Always executed atomically and in order.

Parameter
Name Description
var array<Google\Cloud\Firestore\V1\Write>
Returns
Type Description
$this

getTransaction

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

Returns
Type Description
string

setTransaction

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
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
Type Description
Google\Cloud\Firestore\V1\CommitRequest