Cloud Firestore V1 Client - Class FieldFilter (1.34.0)

Version 1.34.0

• 1.47.1 (latest)
• 1.47.0
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

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

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

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 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
Type	Description
Google\Cloud\Firestore\V1\StructuredQuery\FieldReference|null

hasField

clearField

setField

The field to filter by.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1\StructuredQuery\FieldReference

Returns
Type	Description
$this

getOp

The operator to filter by.

Returns
Type	Description
int

setOp

The operator to filter by.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getValue

The value to compare to.

Returns
Type	Description
Google\Cloud\Firestore\V1\Value|null

hasValue

clearValue

setValue

The value to compare to.

Parameter
Name	Description
var	Google\Cloud\Firestore\V1\Value

Returns
Type	Description
$this