Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredAggregationQuery.
Firestore query for running an aggregation over a StructuredQuery.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#aggregations
def aggregations() -> ::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>
Returns
-
(::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.
#aggregations=
def aggregations=(value) -> ::Array<::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation>
Parameter
-
value (::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.
Returns
-
(::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.
#structured_query
def structured_query() -> ::Google::Cloud::Firestore::V1::StructuredQuery
Returns
- (::Google::Cloud::Firestore::V1::StructuredQuery) — Nested structured query.
#structured_query=
def structured_query=(value) -> ::Google::Cloud::Firestore::V1::StructuredQuery
Parameter
- value (::Google::Cloud::Firestore::V1::StructuredQuery) — Nested structured query.
Returns
- (::Google::Cloud::Firestore::V1::StructuredQuery) — Nested structured query.