com.google.firestore.v1

Class AggregationResult

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.AggregationResult

All Implemented Interfaces:

AggregationResultOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AggregationResult
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AggregationResult.Builder The result of a single bucket from a Firestore aggregation query.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGGREGATE_FIELDS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsAggregateFields(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
boolean	equals(Object obj)
Map<String,Value>	getAggregateFields() Deprecated.
int	getAggregateFieldsCount() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Map<String,Value>	getAggregateFieldsMap() The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrDefault(String key, Value defaultValue) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
Value	getAggregateFieldsOrThrow(String key) The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
static AggregationResult	getDefaultInstance()
AggregationResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<AggregationResult>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static AggregationResult.Builder	newBuilder()
static AggregationResult.Builder	newBuilder(AggregationResult prototype)
AggregationResult.Builder	newBuilderForType()
protected AggregationResult.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AggregationResult	parseDelimitedFrom(InputStream input)
static AggregationResult	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AggregationResult	parseFrom(byte[] data)
static AggregationResult	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AggregationResult	parseFrom(ByteBuffer data)
static AggregationResult	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AggregationResult	parseFrom(com.google.protobuf.ByteString data)
static AggregationResult	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AggregationResult	parseFrom(com.google.protobuf.CodedInputStream input)
static AggregationResult	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AggregationResult	parseFrom(InputStream input)
static AggregationResult	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AggregationResult>	parser()
AggregationResult.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

AGGREGATE_FIELDS_FIELD_NUMBER

public static final int AGGREGATE_FIELDS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getAggregateFieldsCount

public int getAggregateFieldsCount()

Description copied from interface: AggregationResultOrBuilder

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.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;

Specified by:

getAggregateFieldsCount in interface AggregationResultOrBuilder

containsAggregateFields

public boolean containsAggregateFields(String key)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.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;

Specified by:

containsAggregateFields in interface AggregationResultOrBuilder

getAggregateFields

@Deprecated
public Map<String,Value> getAggregateFields()

Deprecated.

Use getAggregateFieldsMap() instead.

Specified by:

getAggregateFields in interface AggregationResultOrBuilder

getAggregateFieldsMap

public Map<String,Value> getAggregateFieldsMap()

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.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;

Specified by:

getAggregateFieldsMap in interface AggregationResultOrBuilder

getAggregateFieldsOrDefault

public Value getAggregateFieldsOrDefault(String key,
                                         Value defaultValue)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.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;

Specified by:

getAggregateFieldsOrDefault in interface AggregationResultOrBuilder

getAggregateFieldsOrThrow

public Value getAggregateFieldsOrThrow(String key)

 The result of the aggregation functions, ex: `COUNT(*) AS total_docs`.
 The key is the
 [alias][google.firestore.v1.StructuredAggregationQuery.Aggregation.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;

Specified by:

getAggregateFieldsOrThrow in interface AggregationResultOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AggregationResult parseFrom(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AggregationResult parseFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static AggregationResult parseFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static AggregationResult parseDelimitedFrom(InputStream input)
                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static AggregationResult parseDelimitedFrom(InputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException

Throws:

IOException

parseFrom

public static AggregationResult parseFrom(com.google.protobuf.CodedInputStream input)
                                   throws IOException

Throws:

IOException

parseFrom

public static AggregationResult parseFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

newBuilderForType

public AggregationResult.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AggregationResult.Builder newBuilder()

newBuilder

public static AggregationResult.Builder newBuilder(AggregationResult prototype)

toBuilder

public AggregationResult.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AggregationResult.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AggregationResult getDefaultInstance()

parser

public static com.google.protobuf.Parser<AggregationResult> parser()

getParserForType

public com.google.protobuf.Parser<AggregationResult> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AggregationResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder