Package com.google.firestore.v1

Class ExecutePipelineResponse

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

  • Field Details

    • TRANSACTION_FIELD_NUMBER

      public static final int TRANSACTION_FIELD_NUMBER
      See Also:

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:

    • EXECUTION_TIME_FIELD_NUMBER

      public static final int EXECUTION_TIME_FIELD_NUMBER
      See Also:

    • EXPLAIN_STATS_FIELD_NUMBER

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

    • getTransaction

      public 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;
      Specified by:
      getTransaction in interface ExecutePipelineResponseOrBuilder
      Returns:
      The transaction.

    • getResultsList

      public 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;
      Specified by:
      getResultsList in interface ExecutePipelineResponseOrBuilder

    • getResultsOrBuilderList

      public 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;
      Specified by:
      getResultsOrBuilderList in interface ExecutePipelineResponseOrBuilder

    • getResultsCount

      public 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;
      Specified by:
      getResultsCount in interface ExecutePipelineResponseOrBuilder

    • getResults

      public 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;
      Specified by:
      getResults in interface ExecutePipelineResponseOrBuilder

    • getResultsOrBuilder

      public 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;
      Specified by:
      getResultsOrBuilder in interface ExecutePipelineResponseOrBuilder

    • hasExecutionTime

      public 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;
      Specified by:
      hasExecutionTime in interface ExecutePipelineResponseOrBuilder
      Returns:
      Whether the executionTime field is set.

    • getExecutionTime

      public 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;
      Specified by:
      getExecutionTime in interface ExecutePipelineResponseOrBuilder
      Returns:
      The executionTime.

    • getExecutionTimeOrBuilder

      public 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;
      Specified by:
      getExecutionTimeOrBuilder in interface ExecutePipelineResponseOrBuilder

    • hasExplainStats

      public 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;
      Specified by:
      hasExplainStats in interface ExecutePipelineResponseOrBuilder
      Returns:
      Whether the explainStats field is set.

    • getExplainStats

      public 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;
      Specified by:
      getExplainStats in interface ExecutePipelineResponseOrBuilder
      Returns:
      The explainStats.

    • getExplainStatsOrBuilder

      public 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;
      Specified by:
      getExplainStatsOrBuilder in interface ExecutePipelineResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static ExecutePipelineResponse.Builder newBuilder()

    • newBuilder

      public static ExecutePipelineResponse.Builder newBuilder(ExecutePipelineResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static ExecutePipelineResponse getDefaultInstance()

    • parser

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

    • getParserForType

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