Cloud Firestore Client - Class FieldValueInterface (2.3.3)

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

Represents a special Field Value.

A special field value which is handled by the client to accomplish a specific task, such as field deletion. Instances of FieldValueInterface do not enqueue a DocumentTransform mutation. to enqueue a transform, use DocumentTransformInterface.

Namespace

Google \ Cloud \ Firestore \ FieldValue

Methods

includeInUpdateMask

Whether the value should be included in the update mask.

Returns
Type Description
bool

setFieldPath

Set the transform field path.

Parameter
Name Description
fieldPath Google\Cloud\Firestore\FieldPath
Returns
Type Description
void

fieldPath

Get the transform field path.

Returns
Type Description
Google\Cloud\Firestore\FieldPath|null