Cloud Firestore V1 API - Class Google::Cloud::Firestore::V1::ExecutePipelineResponse (v2.3.0)

Reference documentation and code samples for the Cloud Firestore V1 API class Google::Cloud::Firestore::V1::ExecutePipelineResponse.

The response for [Firestore.Execute][].

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#execution_time

def execution_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — 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.

#execution_time=

def execution_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
  • value (::Google::Protobuf::Timestamp) — 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.

Returns
  • (::Google::Protobuf::Timestamp) — 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.

#explain_stats

def explain_stats() -> ::Google::Cloud::Firestore::V1::ExplainStats
Returns
  • (::Google::Cloud::Firestore::V1::ExplainStats) — 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.

#explain_stats=

def explain_stats=(value) -> ::Google::Cloud::Firestore::V1::ExplainStats
Parameter
  • value (::Google::Cloud::Firestore::V1::ExplainStats) — 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.

Returns
  • (::Google::Cloud::Firestore::V1::ExplainStats) — 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.

#results

def results() -> ::Array<::Google::Cloud::Firestore::V1::Document>
Returns
  • (::Array<::Google::Cloud::Firestore::V1::Document>) — 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__ and __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.

#results=

def results=(value) -> ::Array<::Google::Cloud::Firestore::V1::Document>
Parameter
  • value (::Array<::Google::Cloud::Firestore::V1::Document>) — 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__ and __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.

Returns
  • (::Array<::Google::Cloud::Firestore::V1::Document>) — 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__ and __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.

#transaction

def transaction() -> ::String
Returns
  • (::String) — 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][].

#transaction=

def transaction=(value) -> ::String
Parameter
  • value (::String) — 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][].

Returns
  • (::String) — 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][].