Package com.google.firestore.v1

Interface ExecutePipelineResponseOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getExecutionTime()
    The time at which the results are valid.
    com.google.protobuf.TimestampOrBuilder
    getExecutionTimeOrBuilder()
    The time at which the results are valid.
    ExplainStats
    getExplainStats()
    Query explain stats.
    ExplainStatsOrBuilder
    getExplainStatsOrBuilder()
    Query explain stats.
    Document
    getResults(int index)
    An ordered batch of results returned executing a pipeline.
    int
    getResultsCount()
    An ordered batch of results returned executing a pipeline.
    List<Document>
    getResultsList()
    An ordered batch of results returned executing a pipeline.
    DocumentOrBuilder
    getResultsOrBuilder(int index)
    An ordered batch of results returned executing a pipeline.
    List<? extends DocumentOrBuilder>
    getResultsOrBuilderList()
    An ordered batch of results returned executing a pipeline.
    com.google.protobuf.ByteString
    getTransaction()
    Newly created transaction identifier.
    boolean
    hasExecutionTime()
    The time at which the results are valid.
    boolean
    hasExplainStats()
    Query explain stats.

    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()
       Newly created transaction identifier.

 This field is only specified as part of the first response from the server,
 alongside the `results` field when the original request specified
 [ExecuteRequest.new_transaction][].
      bytes transaction = 1;
      Returns:
      The transaction.

    • getResultsList

      List<Document> getResultsList()
       An ordered batch of results returned executing a pipeline.

 The batch size is variable, and can even be zero for when only a partial
 progress message is returned.

 The fields present in the returned documents are only those that were
 explicitly requested in the pipeline, this includes those like
 [`__name__`][google.firestore.v1.Document.name] and
 [`__update_time__`][google.firestore.v1.Document.update_time]. This is
 explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
 RPCs which always return such fields even when they are not specified in
 the [`mask`][google.firestore.v1.DocumentMask].
      repeated .google.firestore.v1.Document results = 2;

    • getResults

      Document getResults(int index)
       An ordered batch of results returned executing a pipeline.

 The batch size is variable, and can even be zero for when only a partial
 progress message is returned.

 The fields present in the returned documents are only those that were
 explicitly requested in the pipeline, this includes those like
 [`__name__`][google.firestore.v1.Document.name] and
 [`__update_time__`][google.firestore.v1.Document.update_time]. This is
 explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
 RPCs which always return such fields even when they are not specified in
 the [`mask`][google.firestore.v1.DocumentMask].
      repeated .google.firestore.v1.Document results = 2;

    • getResultsCount

      int getResultsCount()
       An ordered batch of results returned executing a pipeline.

 The batch size is variable, and can even be zero for when only a partial
 progress message is returned.

 The fields present in the returned documents are only those that were
 explicitly requested in the pipeline, this includes those like
 [`__name__`][google.firestore.v1.Document.name] and
 [`__update_time__`][google.firestore.v1.Document.update_time]. This is
 explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
 RPCs which always return such fields even when they are not specified in
 the [`mask`][google.firestore.v1.DocumentMask].
      repeated .google.firestore.v1.Document results = 2;

    • getResultsOrBuilderList

      List<? extends DocumentOrBuilder> getResultsOrBuilderList()
       An ordered batch of results returned executing a pipeline.

 The batch size is variable, and can even be zero for when only a partial
 progress message is returned.

 The fields present in the returned documents are only those that were
 explicitly requested in the pipeline, this includes those like
 [`__name__`][google.firestore.v1.Document.name] and
 [`__update_time__`][google.firestore.v1.Document.update_time]. This is
 explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
 RPCs which always return such fields even when they are not specified in
 the [`mask`][google.firestore.v1.DocumentMask].
      repeated .google.firestore.v1.Document results = 2;

    • getResultsOrBuilder

      DocumentOrBuilder getResultsOrBuilder(int index)
       An ordered batch of results returned executing a pipeline.

 The batch size is variable, and can even be zero for when only a partial
 progress message is returned.

 The fields present in the returned documents are only those that were
 explicitly requested in the pipeline, this includes those like
 [`__name__`][google.firestore.v1.Document.name] and
 [`__update_time__`][google.firestore.v1.Document.update_time]. This is
 explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument`
 RPCs which always return such fields even when they are not specified in
 the [`mask`][google.firestore.v1.DocumentMask].
      repeated .google.firestore.v1.Document results = 2;

    • hasExecutionTime

      boolean hasExecutionTime()
       The time at which the results are valid.

 This is a (not strictly) monotonically increasing value across multiple
 responses in the same stream. The API guarantees that all previously
 returned results are still valid at the latest `execution_time`. This
 allows the API consumer to treat the query if it ran at the latest
 `execution_time` returned.

 If the query returns no results, a response with `execution_time` and no
 `results` will be sent, and this represents the time at which the operation
 was run.
      .google.protobuf.Timestamp execution_time = 3;
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      com.google.protobuf.Timestamp getExecutionTime()
       The time at which the results are valid.

 This is a (not strictly) monotonically increasing value across multiple
 responses in the same stream. The API guarantees that all previously
 returned results are still valid at the latest `execution_time`. This
 allows the API consumer to treat the query if it ran at the latest
 `execution_time` returned.

 If the query returns no results, a response with `execution_time` and no
 `results` will be sent, and this represents the time at which the operation
 was run.
      .google.protobuf.Timestamp execution_time = 3;
      Returns:
      The executionTime.

    • getExecutionTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getExecutionTimeOrBuilder()
       The time at which the results are valid.

 This is a (not strictly) monotonically increasing value across multiple
 responses in the same stream. The API guarantees that all previously
 returned results are still valid at the latest `execution_time`. This
 allows the API consumer to treat the query if it ran at the latest
 `execution_time` returned.

 If the query returns no results, a response with `execution_time` and no
 `results` will be sent, and this represents the time at which the operation
 was run.
      .google.protobuf.Timestamp execution_time = 3;

    • hasExplainStats

      boolean hasExplainStats()
       Query explain stats.

 This is present on the **last** response if the request configured explain
 to run in 'analyze' or 'explain' mode in the pipeline options. If the query
 does not return any results, a response with `explain_stats` and no
 `results` will still be sent.
      .google.firestore.v1.ExplainStats explain_stats = 4;
      Returns:
      Whether the explainStats field is set.

    • getExplainStats

      ExplainStats getExplainStats()
       Query explain stats.

 This is present on the **last** response if the request configured explain
 to run in 'analyze' or 'explain' mode in the pipeline options. If the query
 does not return any results, a response with `explain_stats` and no
 `results` will still be sent.
      .google.firestore.v1.ExplainStats explain_stats = 4;
      Returns:
      The explainStats.

    • getExplainStatsOrBuilder

      ExplainStatsOrBuilder getExplainStatsOrBuilder()
       Query explain stats.

 This is present on the **last** response if the request configured explain
 to run in 'analyze' or 'explain' mode in the pipeline options. If the query
 does not return any results, a response with `explain_stats` and no
 `results` will still be sent.
      .google.firestore.v1.ExplainStats explain_stats = 4;