Cloud Firestore V1 Client - Class BatchWriteRequest (1.31.0)

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

The request for Firestore.BatchWrite.

Generated from protobuf message google.firestore.v1.BatchWriteRequest

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. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

↳ labels array|Google\Protobuf\Internal\MapField

Labels associated with this batch write.

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.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setWrites

The writes to apply.

Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.

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

getLabels

Labels associated with this batch write.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels associated with this batch write.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this