Cloud Firestore Client - Class DocumentTransformInterface (2.3.3)

2.3.3 (latest) 2.2.0-RC1 2.1.0 2.0.2-RC1 1.55.0 1.54.4 1.53.1 1.52.0 1.51.0 1.50.0 1.48.1 1.47.3 1.46.0 1.45.2 1.44.1 1.43.3 1.40.0 1.39.0 1.38.0 1.37.7 1.36.1 1.35.0 1.34.0 1.33.0 1.32.0 1.31.0 1.30.0 1.28.0 1.27.3

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

Represents a DocumentTransform value.

A DocumentTransformInterface instance defines the structure of a Google\Cloud\Firestore\V1\DocumentTransform\FieldTransform message. $key defines the oneof transformType key, and $args defines the transformType message data.

Namespace

Google \ Cloud \ Firestore \ FieldValue

Methods

key

Get the transform key.

Returns
Type	Description
string

args

Get the transform arguments.

Returns
Type	Description
mixed

sendRaw

Whether the argument should be mapped or sent as given.

Returns
Type	Description
bool