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 | |
|---|---|
| Name | Description |
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:
- Conform to document field name limitations.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFieldPath
The relative path of the document being referenced.
Requires:
- Conform to document field name limitations.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|