Class ExecutePipelineResponse

The response for Firestore.Execute.

Inheritance

object

ExecutePipelineResponse

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Firestore.v1.Data

Assembly: Google.Apis.Firestore.v1.dll

Syntax

public class ExecutePipelineResponse : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExecutionTime

object representation of ExecutionTimeRaw.

Declaration

[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use ExecutionTimeDateTimeOffset instead.")]
public virtual object ExecutionTime { get; set; }

Property Value

Type	Description
object

ExecutionTimeDateTimeOffset

DateTimeOffset representation of ExecutionTimeRaw.

Declaration

[JsonIgnore]
public virtual DateTimeOffset? ExecutionTimeDateTimeOffset { get; set; }

Property Value

Type	Description
DateTimeOffset?

ExecutionTimeRaw

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.

Declaration

[JsonProperty("executionTime")]
public virtual string ExecutionTimeRaw { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("explainStats")]
public virtual ExplainStats ExplainStats { get; set; }

Property Value

Type	Description
ExplainStats

Results

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.

Declaration

[JsonProperty("results")]
public virtual IList<Document> Results { get; set; }

Property Value

Type	Description
IList<Document>

Transaction

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.

Declaration

[JsonProperty("transaction")]
public virtual string Transaction { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema