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()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public AggregationResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public AggregationResult build()
Returns
buildPartial()
public AggregationResult buildPartial()
Returns
clear()
public AggregationResult.Builder clear()
Returns
Overrides
clearAggregateFields()
public AggregationResult.Builder clearAggregateFields()
Returns
clearField(Descriptors.FieldDescriptor field)
public AggregationResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public AggregationResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clone()
public AggregationResult.Builder clone()
Returns
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
Returns
getAggregateFields()
public Map<String,Value> getAggregateFields()
Returns
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
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
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
Returns
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
Returns
getDefaultInstanceForType()
public AggregationResult getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getMutableAggregateFields()
public Map<String,Value> getMutableAggregateFields()
Use alternate mutation accessors instead.
Returns
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(AggregationResult other)
public AggregationResult.Builder mergeFrom(AggregationResult other)
Parameter
Returns
public AggregationResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public AggregationResult.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AggregationResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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
Returns
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
Returns
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
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public AggregationResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public AggregationResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final AggregationResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides