Class AggregationResult (3.25.1)

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
Type Description
int

Static Methods

getDefaultInstance()

public static AggregationResult getDefaultInstance()
Returns
Type Description
AggregationResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AggregationResult.Builder newBuilder()
Returns
Type Description
AggregationResult.Builder

newBuilder(AggregationResult prototype)

public static AggregationResult.Builder newBuilder(AggregationResult prototype)
Parameter
Name Description
prototype AggregationResult
Returns
Type Description
AggregationResult.Builder

parseDelimitedFrom(InputStream input)

public static AggregationResult parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AggregationResult parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AggregationResult parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AggregationResult parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AggregationResult parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AggregationResult parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregationResult
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AggregationResult> parser()
Returns
Type Description
Parser<AggregationResult>

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
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregateFields() (deprecated)

public Map<String,Value> getAggregateFields()
Returns
Type Description
Map<String,Value>

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;

Returns
Type Description
Map<String,Value>

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()
Returns
Type Description
AggregationResult

getParserForType()

public Parser<AggregationResult> getParserForType()
Returns
Type Description
Parser<AggregationResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AggregationResult.Builder newBuilderForType()
Returns
Type Description
AggregationResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AggregationResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AggregationResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AggregationResult.Builder toBuilder()
Returns
Type Description
AggregationResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException