Firestore v1 API - Class ExecutePipelineResponse (4.1.0) 

public sealed class ExecutePipelineResponse : IMessage<ExecutePipelineResponse>, IEquatable<ExecutePipelineResponse>, IDeepCloneable<ExecutePipelineResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Firestore v1 API class ExecutePipelineResponse.

The response for [Firestore.Execute][].

Inheritance

object > ExecutePipelineResponse

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

ExecutePipelineResponse()

public ExecutePipelineResponse()

ExecutePipelineResponse(ExecutePipelineResponse)

public ExecutePipelineResponse(ExecutePipelineResponse other)
Parameter
Name Description
other ExecutePipelineResponse

Properties

ExecutionTime

public Timestamp ExecutionTime { get; set; }

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.

Property Value
Type Description
Timestamp

ExplainStats

public ExplainStats ExplainStats { get; set; }

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.

Property Value
Type Description
ExplainStats

Results

public RepeatedField<Document> Results { get; }

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].

Property Value
Type Description
RepeatedFieldDocument

Transaction

public ByteString Transaction { get; set; }

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][].

Property Value
Type Description
ByteString