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.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
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 |
key |
String
|
getAggregateFields() (deprecated)
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 |
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()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getMutableAggregateFields() (deprecated)
public Map<String,Value> getMutableAggregateFields()
Use alternate mutation accessors instead.
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
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 |
other |
Message
|
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;
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
|
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 |
key |
String
|
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
