Cloud Firestore V1 Client - Class StructuredAggregationQuery (1.53.0)

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

Firestore query for running an aggregation over a StructuredQuery .

Generated from protobuf message google.firestore.v1.StructuredAggregationQuery

Namespace

Google \ Cloud \ Firestore \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ structured_query
StructuredQuery

Nested structured query.

↳ aggregations
array< StructuredAggregationQuery\Aggregation >

Optional. Series of aggregations to apply over the results of the structured_query . Requires: * * A minimum of one and maximum of five aggregations per query.

getStructuredQuery

Nested structured query.

Returns
Type
Description

hasStructuredQuery

setStructuredQuery

Nested structured query.

Parameter
Name
Description
Returns
Type
Description
$this

getAggregations

Optional. Series of aggregations to apply over the results of the structured_query .

Requires:

  • A minimum of one and maximum of five aggregations per query.
Returns
Type
Description

setAggregations

Optional. Series of aggregations to apply over the results of the structured_query .

Requires:

  • A minimum of one and maximum of five aggregations per query.
Parameter
Name
Description
Returns
Type
Description
$this

getQueryType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: