Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation (v0.8.0)

Version 0.8.0

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.8

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation.

Defines a aggregation that produces a single result.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#alias

def alias() -> ::String

Returns

• (::String) —

  Optional. Optional name of the field to store the result of the aggregation into.

  If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... );

  becomes:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... );

  Requires:

  • Must be unique across all aggregation aliases.
  • Conform to document field name limitations.

#alias=

def alias=(value) -> ::String

Parameter

• value (::String) —

  Optional. Optional name of the field to store the result of the aggregation into.

  If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... );

  becomes:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... );

  Requires:

  • Must be unique across all aggregation aliases.
  • Conform to document field name limitations.

Returns

• (::String) —

  Optional. Optional name of the field to store the result of the aggregation into.

  If not provided, Firestore will pick a default name following the format field_<incremental_id++>. For example:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... );

  becomes:

  AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS field_2 OVER ( ... );

  Requires:

  • Must be unique across all aggregation aliases.
  • Conform to document field name limitations.

#count

def count() -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count

Returns

• (::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count) — Count aggregator.

#count=

def count=(value) -> ::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count

Parameter

• value (::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count) — Count aggregator.

Returns

• (::Google::Cloud::Firestore::V1::StructuredAggregationQuery::Aggregation::Count) — Count aggregator.