Send feedback
Class StructuredAggregationQuery (3.8.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.8.0 keyboard_arrow_down
public final class StructuredAggregationQuery extends GeneratedMessageV3 implements StructuredAggregationQueryOrBuilder
Firestore query for running an aggregation over a
StructuredQuery .
Protobuf type google.firestore.v1.StructuredAggregationQuery
Static Fields
AGGREGATIONS_FIELD_NUMBER
public static final int AGGREGATIONS_FIELD_NUMBER
Field Value
STRUCTURED_QUERY_FIELD_NUMBER
public static final int STRUCTURED_QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static StructuredAggregationQuery getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static StructuredAggregationQuery . Builder newBuilder ()
Returns
newBuilder(StructuredAggregationQuery prototype)
public static StructuredAggregationQuery . Builder newBuilder ( StructuredAggregationQuery prototype )
Parameter
Returns
public static StructuredAggregationQuery parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static StructuredAggregationQuery parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static StructuredAggregationQuery parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static StructuredAggregationQuery parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static StructuredAggregationQuery parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static StructuredAggregationQuery parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static StructuredAggregationQuery parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static StructuredAggregationQuery parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static StructuredAggregationQuery parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredAggregationQuery parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<StructuredAggregationQuery> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
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
Returns
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
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];
Returns
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
Returns
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 ()
Returns
getParserForType()
public Parser<StructuredAggregationQuery> getParserForType ()
Returns
Overrides
getQueryTypeCase()
public StructuredAggregationQuery . QueryTypeCase getQueryTypeCase ()
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getStructuredQuery()
public StructuredQuery getStructuredQuery ()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
Returns
getStructuredQueryOrBuilder()
public StructuredQueryOrBuilder getStructuredQueryOrBuilder ()
Nested structured query.
.google.firestore.v1.StructuredQuery structured_query = 1;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public StructuredAggregationQuery . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredAggregationQuery . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public StructuredAggregationQuery . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-27 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-27 UTC."],[],[]]
