Package com.google.firestore.v1

Class RunAggregationQueryResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.RunAggregationQueryResponse
All Implemented Interfaces:
RunAggregationQueryResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class RunAggregationQueryResponse extends com.google.protobuf.GeneratedMessageV3 implements RunAggregationQueryResponseOrBuilder
 The response for
 [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].
Protobuf type google.firestore.v1.RunAggregationQueryResponse
See Also:

  • Field Details

    • RESULT_FIELD_NUMBER

      public static final int RESULT_FIELD_NUMBER
      See Also:

    • TRANSACTION_FIELD_NUMBER

      public static final int TRANSACTION_FIELD_NUMBER
      See Also:

    • READ_TIME_FIELD_NUMBER

      public static final int READ_TIME_FIELD_NUMBER
      See Also:

    • EXPLAIN_METRICS_FIELD_NUMBER

      public static final int EXPLAIN_METRICS_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

    • hasResult

      public boolean hasResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      hasResult in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the result field is set.

    • getResult

      public AggregationResult getResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      getResult in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The result.

    • getResultOrBuilder

      public AggregationResultOrBuilder getResultOrBuilder()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Specified by:
      getResultOrBuilder in interface RunAggregationQueryResponseOrBuilder

    • getTransaction

      public com.google.protobuf.ByteString getTransaction()
       The transaction that was started as part of this request.

 Only present on the first response when the request requested to start
 a new transaction.
      bytes transaction = 2;
      Specified by:
      getTransaction in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The transaction.

    • hasReadTime

      public boolean hasReadTime()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      hasReadTime in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the readTime field is set.

    • getReadTime

      public com.google.protobuf.Timestamp getReadTime()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTime in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
       The time at which the aggregate result was computed. This is always
 monotonically increasing; in this case, the previous AggregationResult in
 the result stream are guaranteed not to have changed between their
 `read_time` and this one.

 If the query returns no results, a response with `read_time` and no
 `result` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;
      Specified by:
      getReadTimeOrBuilder in interface RunAggregationQueryResponseOrBuilder

    • hasExplainMetrics

      public boolean hasExplainMetrics()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      hasExplainMetrics in interface RunAggregationQueryResponseOrBuilder
      Returns:
      Whether the explainMetrics field is set.

    • getExplainMetrics

      public ExplainMetrics getExplainMetrics()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      getExplainMetrics in interface RunAggregationQueryResponseOrBuilder
      Returns:
      The explainMetrics.

    • getExplainMetricsOrBuilder

      public ExplainMetricsOrBuilder getExplainMetricsOrBuilder()
       Query explain metrics. This is only present when the
 [RunAggregationQueryRequest.explain_options][google.firestore.v1.RunAggregationQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 10;
      Specified by:
      getExplainMetricsOrBuilder in interface RunAggregationQueryResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RunAggregationQueryResponse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RunAggregationQueryResponse.Builder newBuilder()

    • newBuilder

      public static RunAggregationQueryResponse.Builder newBuilder(RunAggregationQueryResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RunAggregationQueryResponse getDefaultInstance()

    • parser

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

    • getParserForType

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