Send feedback
Class StructuredAggregationQuery.Aggregation (3.17.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.17.0 keyboard_arrow_down
public static final class StructuredAggregationQuery . Aggregation extends GeneratedMessageV3 implements StructuredAggregationQuery . AggregationOrBuilder
Defines an aggregation that produces a single result.
Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ALIAS_FIELD_NUMBER
public static final int ALIAS_FIELD_NUMBER
Field Value Type Description int
AVG_FIELD_NUMBER
public static final int AVG_FIELD_NUMBER
Field Value Type Description int
COUNT_FIELD_NUMBER
public static final int COUNT_FIELD_NUMBER
Field Value Type Description int
SUM_FIELD_NUMBER
public static final int SUM_FIELD_NUMBER
Field Value Type Description int
Static Methods
getDefaultInstance()
public static StructuredAggregationQuery . Aggregation getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static StructuredAggregationQuery . Aggregation . Builder newBuilder ()
newBuilder(StructuredAggregationQuery.Aggregation prototype)
public static StructuredAggregationQuery . Aggregation . Builder newBuilder ( StructuredAggregationQuery . Aggregation prototype )
public static StructuredAggregationQuery . Aggregation parseDelimitedFrom ( InputStream input )
public static StructuredAggregationQuery . Aggregation parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static StructuredAggregationQuery . Aggregation parseFrom ( byte [] data )
Parameter Name Description data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery . Aggregation parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static StructuredAggregationQuery . Aggregation parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery . Aggregation parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static StructuredAggregationQuery . Aggregation parseFrom ( CodedInputStream input )
public static StructuredAggregationQuery . Aggregation parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static StructuredAggregationQuery . Aggregation parseFrom ( InputStream input )
public static StructuredAggregationQuery . Aggregation parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery . Aggregation parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery . Aggregation parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<StructuredAggregationQuery . Aggregation > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter Name Description obj
Object
Overrides
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
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description String
The alias.
getAliasBytes()
public 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
limitations.
string alias = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns Type Description ByteString
The bytes for alias.
getAvg()
public StructuredAggregationQuery . Aggregation . Avg getAvg ()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
getAvgOrBuilder()
public StructuredAggregationQuery . Aggregation . AvgOrBuilder getAvgOrBuilder ()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
getCount()
public StructuredAggregationQuery . Aggregation . Count getCount ()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
getCountOrBuilder()
public StructuredAggregationQuery . Aggregation . CountOrBuilder getCountOrBuilder ()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
getDefaultInstanceForType()
public StructuredAggregationQuery . Aggregation getDefaultInstanceForType ()
getOperatorCase()
public StructuredAggregationQuery . Aggregation . OperatorCase getOperatorCase ()
getParserForType()
public Parser<StructuredAggregationQuery . Aggregation > getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns Type Description int
Overrides
getSum()
public StructuredAggregationQuery . Aggregation . Sum getSum ()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
getSumOrBuilder()
public StructuredAggregationQuery . Aggregation . SumOrBuilder getSumOrBuilder ()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
hasAvg()
Average aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg avg = 3;
Returns Type Description boolean
Whether the avg field is set.
hasCount()
public boolean hasCount ()
Count aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count count = 1;
Returns Type Description boolean
Whether the count field is set.
hasSum()
Sum aggregator.
.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum sum = 2;
Returns Type Description boolean
Whether the sum field is set.
hashCode()
Returns Type Description int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public StructuredAggregationQuery . Aggregation . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery . Aggregation . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Overrides
toBuilder()
public StructuredAggregationQuery . Aggregation . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]