Class AggregationResult (3.14.4)

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
TypeDescription
int

Static Methods

getDefaultInstance()

public static AggregationResult getDefaultInstance()
Returns
TypeDescription
AggregationResult

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AggregationResult.Builder newBuilder()
Returns
TypeDescription
AggregationResult.Builder

newBuilder(AggregationResult prototype)

public static AggregationResult.Builder newBuilder(AggregationResult prototype)
Parameter
NameDescription
prototypeAggregationResult
Returns
TypeDescription
AggregationResult.Builder

parseDelimitedFrom(InputStream input)

public static AggregationResult parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AggregationResult parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AggregationResult parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AggregationResult parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AggregationResult parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AggregationResult parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AggregationResult parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AggregationResult
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AggregationResult> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAggregateFields()

public Map<String,Value> getAggregateFields()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueValue
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
Value

getDefaultInstanceForType()

public AggregationResult getDefaultInstanceForType()
Returns
TypeDescription
AggregationResult

getParserForType()

public Parser<AggregationResult> getParserForType()
Returns
TypeDescription
Parser<AggregationResult>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AggregationResult.Builder newBuilderForType()
Returns
TypeDescription
AggregationResult.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AggregationResult.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AggregationResult.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AggregationResult.Builder toBuilder()
Returns
TypeDescription
AggregationResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException