Interface AggregationResultOrBuilder (3.21.0)

Version 3.21.0

• 3.27.2 (latest)
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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()

Use #getAggregateFieldsMap() instead.

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