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
Static Fields
AGGREGATE_FIELDS_FIELD_NUMBER
public static final int AGGREGATE_FIELDS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AggregationResult getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AggregationResult.Builder newBuilder()
Returns
newBuilder(AggregationResult prototype)
public static AggregationResult.Builder newBuilder(AggregationResult prototype)
Parameter
Returns
public static AggregationResult parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregationResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AggregationResult parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AggregationResult parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregationResult parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AggregationResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AggregationResult parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AggregationResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AggregationResult parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregationResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AggregationResult> parser()
Returns
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
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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
getParserForType()
public Parser<AggregationResult> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AggregationResult.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregationResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AggregationResult.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions