Reference documentation and code samples for the Cloud Firestore V1 Client class Order.
An order on a field.
Generated from protobuf message google.firestore.v1.StructuredQuery.Order
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ field |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference
The field to order by. |
↳ direction |
int
The direction to order by. Defaults to |
getField
The field to order by.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference|null | |
hasField
clearField
setField
The field to order by.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDirection
The direction to order by. Defaults to ASCENDING.
| Returns | |
|---|---|
| Type | Description |
int | |
setDirection
The direction to order by. Defaults to ASCENDING.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |