Cloud Firestore V1 Client - Class FieldReference (1.31.0)

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

A reference to a field in a document, ex: stats.operations.

Generated from protobuf message google.firestore.v1.StructuredQuery.FieldReference

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field_path string

The relative path of the document being referenced. Requires: * Conform to document field name limitations.

getFieldPath

The relative path of the document being referenced.

Requires:

Returns
TypeDescription
string

setFieldPath

The relative path of the document being referenced.

Requires:

Parameter
NameDescription
var string
Returns
TypeDescription
$this