Class AggregationResult (3.15.7)
3.38.0 (latest)
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
3.27.2
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 final class AggregationResult extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AGGREGATE_FIELDS_FIELD_NUMBER
public static final int AGGREGATE_FIELDS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static AggregationResult getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static AggregationResult . Builder newBuilder ()
newBuilder(AggregationResult prototype)
public static AggregationResult . Builder newBuilder ( AggregationResult prototype )
public static AggregationResult parseDelimitedFrom ( InputStream input )
public static AggregationResult parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static AggregationResult parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static AggregationResult parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static AggregationResult parseFrom ( CodedInputStream input )
public static AggregationResult parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static AggregationResult parseFrom ( InputStream input )
public static AggregationResult parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static AggregationResult parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<AggregationResult> parser ()
Methods
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
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAggregateFields()
public Map<String , Value > getAggregateFields ()
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;
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
keyString
defaultValueValue
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
keyString
Returns
Type Description
Value
getDefaultInstanceForType()
public AggregationResult getDefaultInstanceForType ()
getParserForType()
public Parser<AggregationResult> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
numberint
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public AggregationResult . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregationResult . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public AggregationResult . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
