Cloud Firestore V1 Client - Class DocumentTransform (1.45.2)

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

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name Description
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
Type Description
string

setDocument

The name of the document to transform.

Parameter
Name Description
var string
Returns
Type Description
$this

getFieldTransforms

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

This must not be empty.

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