Package com.google.firestore.v1

Interface RunAggregationQueryResponseOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RunAggregationQueryResponse, RunAggregationQueryResponse.Builder
public interface RunAggregationQueryResponseOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    ExplainMetrics
    getExplainMetrics()
    Query explain metrics.
    ExplainMetricsOrBuilder
    getExplainMetricsOrBuilder()
    Query explain metrics.
    com.google.protobuf.Timestamp
    getReadTime()
    The time at which the aggregate result was computed.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The time at which the aggregate result was computed.
    AggregationResult
    getResult()
    A single aggregation result.
    AggregationResultOrBuilder
    getResultOrBuilder()
    A single aggregation result.
    com.google.protobuf.ByteString
    getTransaction()
    The transaction that was started as part of this request.
    boolean
    hasExplainMetrics()
    Query explain metrics.
    boolean
    hasReadTime()
    The time at which the aggregate result was computed.
    boolean
    hasResult()
    A single aggregation result.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasResult

      boolean hasResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Returns:
      Whether the result field is set.

    • getResult

      AggregationResult getResult()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;
      Returns:
      The result.

    • getResultOrBuilder

      AggregationResultOrBuilder getResultOrBuilder()
       A single aggregation result.

 Not present when reporting partial progress.
      .google.firestore.v1.AggregationResult result = 1;

    • getTransaction

      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;
      Returns:
      The transaction.

    • hasReadTime

      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;
      Returns:
      Whether the readTime field is set.

    • getReadTime

      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;
      Returns:
      The readTime.

    • getReadTimeOrBuilder

      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;

    • hasExplainMetrics

      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;
      Returns:
      Whether the explainMetrics field is set.

    • getExplainMetrics

      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;
      Returns:
      The explainMetrics.

    • getExplainMetricsOrBuilder

      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;