Package com.google.firestore.v1

Class StructuredAggregationQuery

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.StructuredAggregationQuery
All Implemented Interfaces:
StructuredAggregationQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class StructuredAggregationQuery extends com.google.protobuf.GeneratedMessageV3 implements StructuredAggregationQueryOrBuilder
 Firestore query for running an aggregation over a
 [StructuredQuery][google.firestore.v1.StructuredQuery].
Protobuf type google.firestore.v1.StructuredAggregationQuery
See Also:

  • Field Details

    • STRUCTURED_QUERY_FIELD_NUMBER

      public static final int STRUCTURED_QUERY_FIELD_NUMBER
      See Also:

    • AGGREGATIONS_FIELD_NUMBER

      public static final int AGGREGATIONS_FIELD_NUMBER
      See Also:

  • 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

    • getQueryTypeCase

      public StructuredAggregationQuery.QueryTypeCase getQueryTypeCase()
      Specified by:
      getQueryTypeCase in interface StructuredAggregationQueryOrBuilder

    • hasStructuredQuery

      public boolean hasStructuredQuery()
       Nested structured query.
      .google.firestore.v1.StructuredQuery structured_query = 1;
      Specified by:
      hasStructuredQuery in interface StructuredAggregationQueryOrBuilder
      Returns:
      Whether the structuredQuery field is set.

    • getStructuredQuery

      public StructuredQuery getStructuredQuery()
       Nested structured query.
      .google.firestore.v1.StructuredQuery structured_query = 1;
      Specified by:
      getStructuredQuery in interface StructuredAggregationQueryOrBuilder
      Returns:
      The structuredQuery.

    • getStructuredQueryOrBuilder

      public StructuredQueryOrBuilder getStructuredQueryOrBuilder()
       Nested structured query.
      .google.firestore.v1.StructuredQuery structured_query = 1;
      Specified by:
      getStructuredQueryOrBuilder in interface StructuredAggregationQueryOrBuilder

    • 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];
      Specified by:
      getAggregationsList in interface StructuredAggregationQueryOrBuilder

    • 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];
      Specified by:
      getAggregationsOrBuilderList in interface StructuredAggregationQueryOrBuilder

    • 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];
      Specified by:
      getAggregationsCount in interface StructuredAggregationQueryOrBuilder

    • getAggregations

      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];
      Specified by:
      getAggregations in interface StructuredAggregationQueryOrBuilder

    • getAggregationsOrBuilder

      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];
      Specified by:
      getAggregationsOrBuilder in interface StructuredAggregationQueryOrBuilder

    • 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 parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static StructuredAggregationQuery 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static StructuredAggregationQuery parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static StructuredAggregationQuery parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

      public StructuredAggregationQuery.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static StructuredAggregationQuery.Builder newBuilder()

    • newBuilder

      public static StructuredAggregationQuery.Builder newBuilder(StructuredAggregationQuery prototype)

    • toBuilder

      public StructuredAggregationQuery.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected StructuredAggregationQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static StructuredAggregationQuery getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<StructuredAggregationQuery> 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 getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder