Send feedback
Class AggregationResult.Builder (3.14.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.14.1 keyboard_arrow_down
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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AggregationResult . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public AggregationResult build ()
buildPartial()
public AggregationResult buildPartial ()
clear()
public AggregationResult . Builder clear ()
Overrides
clearAggregateFields()
public AggregationResult . Builder clearAggregateFields ()
clearField(Descriptors.FieldDescriptor field)
public AggregationResult . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public AggregationResult . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clone()
public AggregationResult . Builder clone ()
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 keyString
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;
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 ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getMutableAggregateFields()
public Map<String , Value > getMutableAggregateFields ()
Use alternate mutation accessors instead.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter Name Description numberint
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField ( int number )
Parameter Name Description numberint
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(AggregationResult other)
public AggregationResult . Builder mergeFrom ( AggregationResult other )
public AggregationResult . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public AggregationResult . Builder mergeFrom ( Message other )
Parameter Name Description otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AggregationResult . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
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;
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;
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 keyString
setField(Descriptors.FieldDescriptor field, Object value)
public AggregationResult . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AggregationResult . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final AggregationResult . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Send feedback
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 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
