Cloud Firestore V1 Client - Class Filter (1.45.1)

Version 1.45.1

• 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 Filter.

A filter.

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

Namespace

Google \ Cloud \ Firestore \ V1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ composite_filter	Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter A composite filter.
↳ field_filter	Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter A filter on a document field.
↳ unary_filter	Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter A filter that takes exactly one argument.

getCompositeFilter

A composite filter.

Returns
Type	Description
Google\Cloud\Firestore\V1\StructuredQuery\CompositeFilter|null

hasCompositeFilter

setCompositeFilter

A composite filter.

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

Returns
Type	Description
$this

getFieldFilter

A filter on a document field.

Returns
Type	Description
Google\Cloud\Firestore\V1\StructuredQuery\FieldFilter|null

hasFieldFilter

setFieldFilter

A filter on a document field.

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

Returns
Type	Description
$this

getUnaryFilter

A filter that takes exactly one argument.

Returns
Type	Description
Google\Cloud\Firestore\V1\StructuredQuery\UnaryFilter|null

hasUnaryFilter

setUnaryFilter

A filter that takes exactly one argument.

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

Returns
Type	Description
$this

getFilterType

Returns
Type	Description
string