com.google.firestore.v1

Interface StructuredAggregationQuery.AggregationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

StructuredAggregationQuery.Aggregation, StructuredAggregationQuery.Aggregation.Builder

Enclosing class:

StructuredAggregationQuery

public static interface StructuredAggregationQuery.AggregationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAlias() Optional.
com.google.protobuf.ByteString	getAliasBytes() Optional.
StructuredAggregationQuery.Aggregation.Count	getCount() Count aggregator.
StructuredAggregationQuery.Aggregation.CountOrBuilder	getCountOrBuilder() Count aggregator.
StructuredAggregationQuery.Aggregation.OperatorCase	getOperatorCase()
boolean	hasCount() Count aggregator.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCount

boolean hasCount()

 Count aggregator.
 

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

Returns:

Whether the count field is set.

getCount

StructuredAggregationQuery.Aggregation.Count getCount()

 Count aggregator.
 

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

Returns:

The count.

getCountOrBuilder

StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()

 Count aggregator.
 

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

getAlias

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][google.firestore.v1.Document.fields]
 limitations.
 

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

Returns:

The alias.

getAliasBytes

com.google.protobuf.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][google.firestore.v1.Document.fields]
 limitations.
 

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

Returns:

The bytes for alias.

getOperatorCase

StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()