Interface StructuredAggregationQuery.AggregationOrBuilder (3.7.3)

Stay organized with collections Save and categorize content based on your preferences.
public static interface StructuredAggregationQuery.AggregationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlias()

public abstract String getAlias()

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: <code><code> 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 ( ... ); </code></code><code> becomes: </code><code><code> 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 ( ... ); </code></code> Requires:

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

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The alias.

getAliasBytes()

public abstract ByteString getAliasBytes()

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: <code><code> 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 ( ... ); </code></code><code> becomes: </code><code><code> 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 ( ... ); </code></code> Requires:

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

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for alias.

getCount()

public abstract StructuredAggregationQuery.Aggregation.Count getCount()

Count aggregator.

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Returns
TypeDescription
StructuredAggregationQuery.Aggregation.Count

The count.

getCountOrBuilder()

public abstract StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()

Count aggregator.

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Returns
TypeDescription
StructuredAggregationQuery.Aggregation.CountOrBuilder

getOperatorCase()

public abstract StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()
Returns
TypeDescription
StructuredAggregationQuery.Aggregation.OperatorCase

hasCount()

public abstract boolean hasCount()

Count aggregator.

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Returns
TypeDescription
boolean

Whether the count field is set.