Cloud Firestore V1 Client - Class StructuredAggregationQuery (1.38.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
NameDescription
data array

Optional. Data for populating the Message object.

↳ structured_query Google\Cloud\Firestore\V1\StructuredQuery

Nested structured query.

↳ aggregations array<Google\Cloud\Firestore\V1\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
TypeDescription
Google\Cloud\Firestore\V1\StructuredQuery|null

hasStructuredQuery

setStructuredQuery

Nested structured query.

Parameter
NameDescription
var Google\Cloud\Firestore\V1\StructuredQuery
Returns
TypeDescription
$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
TypeDescription
Google\Protobuf\Internal\RepeatedField

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
NameDescription
var array<Google\Cloud\Firestore\V1\StructuredAggregationQuery\Aggregation>
Returns
TypeDescription
$this

getQueryType

Returns
TypeDescription
string