Class AggregationResult.Builder (3.24.3)

public static final class AggregationResult.Builder extends GeneratedMessageV3.Builder<AggregationResult.Builder> implements AggregationResultOrBuilder

The result of a single bucket from a Firestore aggregation query.

The keys of aggregate_fields are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.

Protobuf type google.firestore.v1.AggregationResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AggregationResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationResult.Builder
Overrides

build()

public AggregationResult build()
Returns
Type Description
AggregationResult

buildPartial()

public AggregationResult buildPartial()
Returns
Type Description
AggregationResult

clear()

public AggregationResult.Builder clear()
Returns
Type Description
AggregationResult.Builder
Overrides

clearAggregateFields()

public AggregationResult.Builder clearAggregateFields()
Returns
Type Description
AggregationResult.Builder

clearField(Descriptors.FieldDescriptor field)

public AggregationResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AggregationResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public AggregationResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AggregationResult.Builder
Overrides

clone()

public AggregationResult.Builder clone()
Returns
Type Description
AggregationResult.Builder
Overrides

containsAggregateFields(String key)

public 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 Map<String,Value> getAggregateFields()
Returns
Type Description
Map<String,Value>

getAggregateFieldsCount()

public 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 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 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 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

getDefaultInstanceForType()

public AggregationResult getDefaultInstanceForType()
Returns
Type Description
AggregationResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableAggregateFields() (deprecated)

public Map<String,Value> getMutableAggregateFields()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,Value>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AggregationResult other)

public AggregationResult.Builder mergeFrom(AggregationResult other)
Parameter
Name Description
other AggregationResult
Returns
Type Description
AggregationResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AggregationResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AggregationResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AggregationResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AggregationResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationResult.Builder
Overrides

putAggregateFields(String key, Value value)

public AggregationResult.Builder putAggregateFields(String key, Value value)

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
value Value
Returns
Type Description
AggregationResult.Builder

putAggregateFieldsBuilderIfAbsent(String key)

public Value.Builder putAggregateFieldsBuilderIfAbsent(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.Builder

putAllAggregateFields(Map<String,Value> values)

public AggregationResult.Builder putAllAggregateFields(Map<String,Value> values)

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
values Map<String,Value>
Returns
Type Description
AggregationResult.Builder

removeAggregateFields(String key)

public AggregationResult.Builder removeAggregateFields(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
AggregationResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AggregationResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AggregationResult.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AggregationResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AggregationResult.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AggregationResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AggregationResult.Builder
Overrides