Interface AggregationResultOrBuilder (3.25.1)

public interface AggregationResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsAggregateFields(String key)

public abstract boolean containsAggregateFields(String key)

The result of the aggregation functions, ex: COUNT(*) AS total_docs.

The key is the 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;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAggregateFields() (deprecated)

public abstract Map<String,Value> getAggregateFields()
Returns
Type Description
Map<String,Value>

getAggregateFieldsCount()

public abstract int getAggregateFieldsCount()

The result of the aggregation functions, ex: COUNT(*) AS total_docs.

The key is the 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;

Returns
Type Description
int

getAggregateFieldsMap()

public abstract Map<String,Value> getAggregateFieldsMap()

The result of the aggregation functions, ex: COUNT(*) AS total_docs.

The key is the 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;

Returns
Type Description
Map<String,Value>

getAggregateFieldsOrDefault(String key, Value defaultValue)

public abstract Value getAggregateFieldsOrDefault(String key, Value defaultValue)

The result of the aggregation functions, ex: COUNT(*) AS total_docs.

The key is the 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;

Parameters
Name Description
key String
defaultValue Value
Returns
Type Description
Value

getAggregateFieldsOrThrow(String key)

public abstract Value getAggregateFieldsOrThrow(String key)

The result of the aggregation functions, ex: COUNT(*) AS total_docs.

The key is the 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;

Parameter
Name Description
key String
Returns
Type Description
Value