public static interface StructuredAggregationQuery.AggregationOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
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:
`
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
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(*) AS field_2
OVER (
...
);
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
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:
`
AGGREGATE
COUNT_UP_TO(1) AS count_up_to_1,
COUNT_UP_TO(2),
COUNT_UP_TO(3) AS count_up_to_3,
COUNT(*)
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(*) AS field_2
OVER (
...
);
Requires:
- Must be unique across all aggregation aliases.
- Conform to document field name limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for alias. |
getAvg()
public abstract StructuredAggregationQuery.Aggregation.Avg getAvg()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.Avg |
The avg. |
getAvgOrBuilder()
public abstract StructuredAggregationQuery.Aggregation.AvgOrBuilder getAvgOrBuilder()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.AvgOrBuilder |
getCount()
public abstract StructuredAggregationQuery.Aggregation.Count getCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.Count |
The count. |
getCountOrBuilder()
public abstract StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.CountOrBuilder |
getOperatorCase()
public abstract StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.OperatorCase |
getSum()
public abstract StructuredAggregationQuery.Aggregation.Sum getSum()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.Sum |
The sum. |
getSumOrBuilder()
public abstract StructuredAggregationQuery.Aggregation.SumOrBuilder getSumOrBuilder()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
Returns | |
---|---|
Type | Description |
StructuredAggregationQuery.Aggregation.SumOrBuilder |
hasAvg()
public abstract boolean hasAvg()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
Returns | |
---|---|
Type | Description |
boolean |
Whether the avg field is set. |
hasCount()
public abstract boolean hasCount()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
Returns | |
---|---|
Type | Description |
boolean |
Whether the count field is set. |
hasSum()
public abstract boolean hasSum()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
Returns | |
---|---|
Type | Description |
boolean |
Whether the sum field is set. |