Class StructuredAggregationQuery (3.22.0)
3.38.0 (latest)
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
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 StructuredAggregationQuery extends GeneratedMessageV3 implements StructuredAggregationQueryOrBuilder
Firestore query for running an aggregation over a
StructuredQuery .
Protobuf type google.firestore.v1.StructuredAggregationQuery
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
AGGREGATIONS_FIELD_NUMBER
public static final int AGGREGATIONS_FIELD_NUMBER
Field Value
Type Description
int
STRUCTURED_QUERY_FIELD_NUMBER
public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static StructuredAggregationQuery getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static StructuredAggregationQuery . Builder newBuilder ()
newBuilder(StructuredAggregationQuery prototype)
public static StructuredAggregationQuery . Builder newBuilder ( StructuredAggregationQuery prototype )
public static StructuredAggregationQuery parseDelimitedFrom ( InputStream input )
public static StructuredAggregationQuery parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static StructuredAggregationQuery parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static StructuredAggregationQuery parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static StructuredAggregationQuery parseFrom ( CodedInputStream input )
public static StructuredAggregationQuery parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static StructuredAggregationQuery parseFrom ( InputStream input )
public static StructuredAggregationQuery parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<StructuredAggregationQuery> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getAggregations(int index)
public StructuredAggregationQuery . Aggregation getAggregations ( int index )
Optional. Series of aggregations to apply over the results of the
structured_query.
Requires:
A minimum of one and maximum of five aggregations per query.
repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getAggregationsCount()
public int getAggregationsCount ()
Optional. Series of aggregations to apply over the results of the
structured_query.
Requires:
A minimum of one and maximum of five aggregations per query.
repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
int
getAggregationsList()
public List<StructuredAggregationQuery . Aggregation > getAggregationsList ()
Optional. Series of aggregations to apply over the results of the
structured_query.
Requires:
A minimum of one and maximum of five aggregations per query.
repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
getAggregationsOrBuilder(int index)
public StructuredAggregationQuery . AggregationOrBuilder getAggregationsOrBuilder ( int index )
Optional. Series of aggregations to apply over the results of the
structured_query.
Requires:
A minimum of one and maximum of five aggregations per query.
repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter
Name Description
indexint
getAggregationsOrBuilderList()
public List <? extends StructuredAggregationQuery . AggregationOrBuilder > getAggregationsOrBuilderList ()
Optional. Series of aggregations to apply over the results of the
structured_query.
Requires:
A minimum of one and maximum of five aggregations per query.
repeated .google.firestore.v1.StructuredAggregationQuery.Aggregation aggregations = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
List <? extends com.google.firestore.v1.StructuredAggregationQuery.AggregationOrBuilder >
getDefaultInstanceForType()
public StructuredAggregationQuery getDefaultInstanceForType ()
getParserForType()
public Parser<StructuredAggregationQuery> getParserForType ()
Overrides
getQueryTypeCase()
public StructuredAggregationQuery . QueryTypeCase getQueryTypeCase ()
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getStructuredQuery()
public StructuredQuery getStructuredQuery ()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder ()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
hasStructuredQuery()
public boolean hasStructuredQuery ()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
Returns
Type Description
boolean Whether the structuredQuery field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public StructuredAggregationQuery . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public StructuredAggregationQuery . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
