Cloud Firestore V1beta1 Client - Class FieldFilter (1.54.2)

Version latest

• 1.54.2 (latest)
• 1.54.1
• 1.53.1
• 1.52.0
• 1.51.0
• 1.50.0
• 1.48.1
• 1.47.3
• 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

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

A filter on a specific field.

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

Namespace

Google \ Cloud \ Firestore \ V1beta1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ field	FieldReference The field to filter by.
↳ op	int The operator to filter by.
↳ value	Google\Cloud\Firestore\V1beta1\Value The value to compare to.

getField

The field to filter by.

Returns
Type	Description
FieldReference

setField

The field to filter by.

Parameter
Name	Description
var	FieldReference

Returns
Type	Description
$this

getOp

The operator to filter by.

Returns
Type	Description
int	Enum of type Operator.

setOp

The operator to filter by.

Parameter
Name	Description
var	int Enum of type Operator.

Returns
Type	Description
$this

getValue

The value to compare to.

Returns
Type	Description
Google\Cloud\Firestore\V1beta1\Value

setValue

The value to compare to.

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

Returns
Type	Description
$this