Package com.google.firestore.v1

Class StructuredAggregationQuery.Aggregation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.StructuredAggregationQuery.Aggregation

All Implemented Interfaces:

StructuredAggregationQuery.AggregationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

StructuredAggregationQuery

public static final class StructuredAggregationQuery.Aggregation
extends com.google.protobuf.GeneratedMessageV3
implements StructuredAggregationQuery.AggregationOrBuilder

 Defines an aggregation that produces a single result.
 

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	StructuredAggregationQuery.Aggregation.Avg	Average of the values of the requested field
static interface	StructuredAggregationQuery.Aggregation.AvgOrBuilder
static final class	StructuredAggregationQuery.Aggregation.Builder	Defines an aggregation that produces a single result.
static final class	StructuredAggregationQuery.Aggregation.Count	Count of documents that match the query.
static interface	StructuredAggregationQuery.Aggregation.CountOrBuilder
static enum	StructuredAggregationQuery.Aggregation.OperatorCase
static final class	StructuredAggregationQuery.Aggregation.Sum	Sum of the values of the requested field
static interface	StructuredAggregationQuery.Aggregation.SumOrBuilder

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	Description
static final int	ALIAS_FIELD_NUMBER
static final int	AVG_FIELD_NUMBER
static final int	COUNT_FIELD_NUMBER
static final int	SUM_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	Description
boolean	equals(Object obj)
String	getAlias()	Optional.
com.google.protobuf.ByteString	getAliasBytes()	Optional.
StructuredAggregationQuery.Aggregation.Avg	getAvg()	Average aggregator.
StructuredAggregationQuery.Aggregation.AvgOrBuilder	getAvgOrBuilder()	Average aggregator.
StructuredAggregationQuery.Aggregation.Count	getCount()	Count aggregator.
StructuredAggregationQuery.Aggregation.CountOrBuilder	getCountOrBuilder()	Count aggregator.
static StructuredAggregationQuery.Aggregation	getDefaultInstance()
StructuredAggregationQuery.Aggregation	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
StructuredAggregationQuery.Aggregation.OperatorCase	getOperatorCase()
com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation>	getParserForType()
int	getSerializedSize()
StructuredAggregationQuery.Aggregation.Sum	getSum()	Sum aggregator.
StructuredAggregationQuery.Aggregation.SumOrBuilder	getSumOrBuilder()	Sum aggregator.
boolean	hasAvg()	Average aggregator.
boolean	hasCount()	Count aggregator.
int	hashCode()
boolean	hasSum()	Sum aggregator.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static StructuredAggregationQuery.Aggregation.Builder	newBuilder()
static StructuredAggregationQuery.Aggregation.Builder	newBuilder(StructuredAggregationQuery.Aggregation prototype)
StructuredAggregationQuery.Aggregation.Builder	newBuilderForType()
protected StructuredAggregationQuery.Aggregation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StructuredAggregationQuery.Aggregation	parseDelimitedFrom(InputStream input)
static StructuredAggregationQuery.Aggregation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredAggregationQuery.Aggregation	parseFrom(byte[] data)
static StructuredAggregationQuery.Aggregation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredAggregationQuery.Aggregation	parseFrom(com.google.protobuf.ByteString data)
static StructuredAggregationQuery.Aggregation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredAggregationQuery.Aggregation	parseFrom(com.google.protobuf.CodedInputStream input)
static StructuredAggregationQuery.Aggregation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredAggregationQuery.Aggregation	parseFrom(InputStream input)
static StructuredAggregationQuery.Aggregation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StructuredAggregationQuery.Aggregation	parseFrom(ByteBuffer data)
static StructuredAggregationQuery.Aggregation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation>	parser()
StructuredAggregationQuery.Aggregation.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

COUNT_FIELD_NUMBER

public static final int COUNT_FIELD_NUMBER

See Also:

• Constant Field Values

SUM_FIELD_NUMBER

public static final int SUM_FIELD_NUMBER

See Also:

• Constant Field Values

AVG_FIELD_NUMBER

public static final int AVG_FIELD_NUMBER

See Also:

• Constant Field Values

ALIAS_FIELD_NUMBER

public static final int ALIAS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

newInstance

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

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getOperatorCase

public StructuredAggregationQuery.Aggregation.OperatorCase getOperatorCase()

Specified by:

getOperatorCase in interface StructuredAggregationQuery.AggregationOrBuilder

hasCount

public boolean hasCount()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

hasCount in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the count field is set.

getCount

public StructuredAggregationQuery.Aggregation.Count getCount()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

getCount in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The count.

getCountOrBuilder

public StructuredAggregationQuery.Aggregation.CountOrBuilder getCountOrBuilder()

 Count aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;

Specified by:

getCountOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

hasSum

public boolean hasSum()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

hasSum in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the sum field is set.

getSum

public StructuredAggregationQuery.Aggregation.Sum getSum()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

getSum in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The sum.

getSumOrBuilder

public StructuredAggregationQuery.Aggregation.SumOrBuilder getSumOrBuilder()

 Sum aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;

Specified by:

getSumOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

hasAvg

public boolean hasAvg()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

hasAvg in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

Whether the avg field is set.

getAvg

public StructuredAggregationQuery.Aggregation.Avg getAvg()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

getAvg in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The avg.

getAvgOrBuilder

public StructuredAggregationQuery.Aggregation.AvgOrBuilder getAvgOrBuilder()

 Average aggregator.
 

.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;

Specified by:

getAvgOrBuilder in interface StructuredAggregationQuery.AggregationOrBuilder

getAlias

public String getAlias()

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2),
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*)
 OVER (
   ...
 );
 ```

 becomes:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2) AS field_1,
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*) AS field_2
 OVER (
   ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAlias in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The alias.

getAliasBytes

public com.google.protobuf.ByteString getAliasBytes()

 Optional. Optional name of the field to store the result of the
 aggregation into.

 If not provided, Firestore will pick a default name following the format
 `field_<incremental_id++>`. For example:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2),
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*)
 OVER (
   ...
 );
 ```

 becomes:

 ```
 AGGREGATE
   COUNT_UP_TO(1) AS count_up_to_1,
   COUNT_UP_TO(2) AS field_1,
   COUNT_UP_TO(3) AS count_up_to_3,
   COUNT(*) AS field_2
 OVER (
   ...
 );
 ```

 Requires:

 * Must be unique across all aggregation aliases.
 * Conform to [document field name][google.firestore.v1.Document.fields]
 limitations.
 

string alias = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getAliasBytes in interface StructuredAggregationQuery.AggregationOrBuilder

Returns:

The bytes for alias.

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 StructuredAggregationQuery.Aggregation parseFrom(ByteBuffer data)
                                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StructuredAggregationQuery.Aggregation parseFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StructuredAggregationQuery.Aggregation parseDelimitedFrom(InputStream input)
                                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StructuredAggregationQuery.Aggregation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StructuredAggregationQuery.Aggregation.Builder newBuilder()

newBuilder

public static StructuredAggregationQuery.Aggregation.Builder newBuilder(StructuredAggregationQuery.Aggregation prototype)

toBuilder

public StructuredAggregationQuery.Aggregation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StructuredAggregationQuery.Aggregation getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<StructuredAggregationQuery.Aggregation> 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 StructuredAggregationQuery.Aggregation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder