Class AggregationResult (3.5.0)

Version 3.5.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AggregationResult

Implements

AggregationResultOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

getAggregateFields()

public Map<String,Value> getAggregateFields()

Use #getAggregateFieldsMap() instead.

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

hashCode()

public int hashCode()

Returns

Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

internalGetMapField(int number)

protected MapField internalGetMapField(int number)

Parameter

Name	Description
number	int

Returns

Type	Description
MapField

Overrides

GeneratedMessageV3.internalGetMapField(int fieldNumber)

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AggregationResult.Builder toBuilder()

Returns

Type	Description
AggregationResult.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException