Cloud Firestore V1 Client - Class FieldReference (1.46.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

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ field_path string

A reference to a field in a document. Requires: * MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.

getFieldPath

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.
Returns
Type Description
string

setFieldPath

A reference to a field in a document.

Requires:

  • MUST be a dot-delimited (.) string of segments, where each segment conforms to document field name limitations.
Parameter
Name Description
var string
Returns
Type Description
$this