Cloud Firestore V1 Client - Class FieldFilter (1.28.0)

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

A filter on a specific field.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ field Google\Cloud\Firestore\V1\StructuredQuery\FieldReference

The field to filter by.

↳ op int

The operator to filter by.

↳ value Google\Cloud\Firestore\V1\Value

The value to compare to.

getField

The field to filter by.

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

hasField

clearField

setField

The field to filter by.

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

getOp

The operator to filter by.

Returns
TypeDescription
int

setOp

The operator to filter by.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getValue

The value to compare to.

Returns
TypeDescription
Google\Cloud\Firestore\V1\Value|null

hasValue

clearValue

setValue

The value to compare to.

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