Class RunAggregationQueryResponse

The response for Firestore.RunAggregationQuery.

Inheritance

object

RunAggregationQueryResponse

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 RunAggregationQueryResponse : IDirectResponseSchema

Properties

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ExplainMetrics

Query explain metrics. This is only present when the RunAggregationQueryRequest.explain_options is provided, and it is sent only once with the last response in the stream.

Declaration

[JsonProperty("explainMetrics")]
public virtual ExplainMetrics ExplainMetrics { get; set; }

Property Value

Type	Description
ExplainMetrics

ReadTime

object representation of ReadTimeRaw.

Declaration

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

Property Value

Type	Description
object

ReadTimeDateTimeOffset

DateTimeOffset representation of ReadTimeRaw.

Declaration

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

Property Value

Type	Description
DateTimeOffset?

ReadTimeRaw

The time at which the aggregate result was computed. This is always monotonically increasing; in this case, the previous AggregationResult in the result stream are guaranteed not to have changed between their read_time and this one. If the query returns no results, a response with read_time and no result will be sent, and this represents the time at which the query was run.

Declaration

[JsonProperty("readTime")]
public virtual string ReadTimeRaw { get; set; }

Property Value

Type	Description
string

Result

A single aggregation result. Not present when reporting partial progress.

Declaration

[JsonProperty("result")]
public virtual AggregationResult Result { get; set; }

Property Value

Type	Description
AggregationResult

Transaction

The transaction that was started as part of this request. Only present on the first response when the request requested to start a new transaction.

Declaration

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

Property Value

Type	Description
string

Implements

IDirectResponseSchema