Package com.google.firestore.v1

Interface RunQueryResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    RunQueryResponse.ContinuationSelectorCase
    getContinuationSelectorCase()
     
    Document
    getDocument()
    A query result, not set when reporting partial progress.
    DocumentOrBuilder
    getDocumentOrBuilder()
    A query result, not set when reporting partial progress.
    boolean
    getDone()
    If present, Firestore has completely finished the request and no more documents will be returned.
    ExplainMetrics
    getExplainMetrics()
    Query explain metrics.
    ExplainMetricsOrBuilder
    getExplainMetricsOrBuilder()
    Query explain metrics.
    com.google.protobuf.Timestamp
    getReadTime()
    The time at which the document was read.
    com.google.protobuf.TimestampOrBuilder
    getReadTimeOrBuilder()
    The time at which the document was read.
    int
    getSkippedResults()
    The number of results that have been skipped due to an offset between the last response and the current response.
    com.google.protobuf.ByteString
    getTransaction()
    The transaction that was started as part of this request.
    boolean
    hasDocument()
    A query result, not set when reporting partial progress.
    boolean
    hasDone()
    If present, Firestore has completely finished the request and no more documents will be returned.
    boolean
    hasExplainMetrics()
    Query explain metrics.
    boolean
    hasReadTime()
    The time at which the document was read.

    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

    • getTransaction

      com.google.protobuf.ByteString getTransaction()
       The transaction that was started as part of this request.
 Can only be set in the first response, and only if
 [RunQueryRequest.new_transaction][google.firestore.v1.RunQueryRequest.new_transaction]
 was set in the request. If set, no other fields will be set in this
 response.
      bytes transaction = 2;
      Returns:
      The transaction.

    • hasDocument

      boolean hasDocument()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;
      Returns:
      Whether the document field is set.

    • getDocument

      Document getDocument()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;
      Returns:
      The document.

    • getDocumentOrBuilder

      DocumentOrBuilder getDocumentOrBuilder()
       A query result, not set when reporting partial progress.
      .google.firestore.v1.Document document = 1;

    • hasReadTime

      boolean hasReadTime()
       The time at which the document was read. This may be monotonically
 increasing; in this case, the previous documents 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
 `document` 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 document was read. This may be monotonically
 increasing; in this case, the previous documents 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
 `document` 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 document was read. This may be monotonically
 increasing; in this case, the previous documents 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
 `document` will be sent, and this represents the time at which the query
 was run.
      .google.protobuf.Timestamp read_time = 3;

    • getSkippedResults

      int getSkippedResults()
       The number of results that have been skipped due to an offset between
 the last response and the current response.
      int32 skipped_results = 4;
      Returns:
      The skippedResults.

    • hasDone

      boolean hasDone()
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Returns:
      Whether the done field is set.

    • getDone

      boolean getDone()
       If present, Firestore has completely finished the request and no more
 documents will be returned.
      bool done = 6;
      Returns:
      The done.

    • hasExplainMetrics

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

    • getExplainMetrics

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

    • getExplainMetricsOrBuilder

      ExplainMetricsOrBuilder getExplainMetricsOrBuilder()
       Query explain metrics. This is only present when the
 [RunQueryRequest.explain_options][google.firestore.v1.RunQueryRequest.explain_options]
 is provided, and it is sent only once with the last response in the stream.
      .google.firestore.v1.ExplainMetrics explain_metrics = 11;

    • getContinuationSelectorCase

      RunQueryResponse.ContinuationSelectorCase getContinuationSelectorCase()