Cloud Firestore V1 Client - Class DocumentTransform (1.30.0)

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

A transformation of a document.

Generated from protobuf message google.firestore.v1.DocumentTransform

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ document string

The name of the document to transform.

↳ field_transforms array<Google\Cloud\Firestore\V1\DocumentTransform\FieldTransform>

The list of transformations to apply to the fields of the document, in order. This must not be empty.

getDocument

The name of the document to transform.

Returns
TypeDescription
string

setDocument

The name of the document to transform.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFieldTransforms

The list of transformations to apply to the fields of the document, in order.

This must not be empty.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFieldTransforms

The list of transformations to apply to the fields of the document, in order.

This must not be empty.

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