Cloud Firestore V1 Client - Class BatchWriteRequest (1.46.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

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

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
Type Description
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
Name Description
var array<Google\Cloud\Firestore\V1\Write>
Returns
Type Description
$this

getLabels

Labels associated with this batch write.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Labels associated with this batch write.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this