Cloud Firestore V1 Client - Class Order (1.28.0)

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
NameDescription
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 ASCENDING.

getField

The field to order by.

Returns
TypeDescription
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference|null

hasField

clearField

setField

The field to order by.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredQuery\FieldReference
Returns
TypeDescription
$this

getDirection

The direction to order by. Defaults to ASCENDING.

Returns
TypeDescription
int

setDirection

The direction to order by. Defaults to ASCENDING.

Parameter
NameDescription
var int
Returns
TypeDescription
$this