Struct ExecutePipelineResponse 

pub struct ExecutePipelineResponse {
    pub execution_time: Option<DateTime<Utc>>,
    pub explain_stats: Option<ExplainStats>,
    pub results: Option<Vec<Document>>,
    pub transaction: Option<Vec<u8>>,
}

The response for Firestore.Execute.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• databases documents execute pipeline projects (response)

Fields

execution_time: Option<DateTime<Utc>>

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: Option<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: Option<Vec<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: Option<Vec<u8>>

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.

Trait Implementations

impl Clone for ExecutePipelineResponse

fn clone(&self) -> ExecutePipelineResponse

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExecutePipelineResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ExecutePipelineResponse

fn default() -> ExecutePipelineResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExecutePipelineResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExecutePipelineResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ResponseResult for ExecutePipelineResponse