com.google.firestore.v1

Interface AggregationResultOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

AggregationResult, AggregationResult.Builder

public interface AggregationResultOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsAggregateFields(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Map<String,Value>	getAggregateFields() Deprecated.
int	getAggregateFieldsCount() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Map<String,Value>	getAggregateFieldsMap() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrDefault(String key, Value defaultValue) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrThrow(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.

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

getAggregateFieldsCount

int getAggregateFieldsCount()

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
 

map<string, .google.firestore.v1.Value> aggregate_fields = 2;

containsAggregateFields

boolean containsAggregateFields(String key)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
 

map<string, .google.firestore.v1.Value> aggregate_fields = 2;

getAggregateFields

@Deprecated
Map<String,Value> getAggregateFields()

Deprecated.

Use getAggregateFieldsMap() instead.

getAggregateFieldsMap

Map<String,Value> getAggregateFieldsMap()

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
 

map<string, .google.firestore.v1.Value> aggregate_fields = 2;

getAggregateFieldsOrDefault

Value getAggregateFieldsOrDefault(String key,
                                  Value defaultValue)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
 

map<string, .google.firestore.v1.Value> aggregate_fields = 2;

getAggregateFieldsOrThrow

Value getAggregateFieldsOrThrow(String key)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.alias]
 assigned to the aggregation function on input and the size of this map
 equals the number of aggregation functions in the query.
 

map<string, .google.firestore.v1.Value> aggregate_fields = 2;