Cloud Firestore V1beta1 Client - Class Filter (1.44.1)

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

A filter.

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

Namespace

Google \ Cloud \ Firestore \ V1beta1 \ StructuredQuery

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ composite_filter Google\Cloud\Firestore\V1beta1\StructuredQuery\CompositeFilter

A composite filter.
↳ field_filter Google\Cloud\Firestore\V1beta1\StructuredQuery\FieldFilter

A filter on a document field.
↳ unary_filter Google\Cloud\Firestore\V1beta1\StructuredQuery\UnaryFilter

A filter that takes exactly one argument.

getCompositeFilter

A composite filter.

Returns
Type Description
Google\Cloud\Firestore\V1beta1\StructuredQuery\CompositeFilter

setCompositeFilter

A composite filter.

Parameter
Name Description
var Google\Cloud\Firestore\V1beta1\StructuredQuery\CompositeFilter
Returns
Type Description
$this

getFieldFilter

A filter on a document field.

Returns
Type Description
Google\Cloud\Firestore\V1beta1\StructuredQuery\FieldFilter

setFieldFilter

A filter on a document field.

Parameter
Name Description
var Google\Cloud\Firestore\V1beta1\StructuredQuery\FieldFilter
Returns
Type Description
$this

getUnaryFilter

A filter that takes exactly one argument.

Returns
Type Description
Google\Cloud\Firestore\V1beta1\StructuredQuery\UnaryFilter

setUnaryFilter

A filter that takes exactly one argument.

Parameter
Name Description
var Google\Cloud\Firestore\V1beta1\StructuredQuery\UnaryFilter
Returns
Type Description
$this

getFilterType

Returns
Type Description
string