Firestore v1 API - Class RunAggregationQueryResponse (3.9.0)

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

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

The response for [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

Inheritance

object > RunAggregationQueryResponse

Implements

IMessage RunAggregationQueryResponse, IEquatable RunAggregationQueryResponse, IDeepCloneable RunAggregationQueryResponse, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Firestore.V1

Assembly

Google.Cloud.Firestore.V1.dll

Constructors

RunAggregationQueryResponse()

public RunAggregationQueryResponse()

RunAggregationQueryResponse(RunAggregationQueryResponse)

public RunAggregationQueryResponse(RunAggregationQueryResponse other)

Parameter
Name	Description
`other`	`RunAggregationQueryResponse`

Properties

ExplainMetrics

public ExplainMetrics ExplainMetrics { get; set; }

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

Property Value
Type	Description
`ExplainMetrics`

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
Type	Description
`Timestamp`

Result

public AggregationResult Result { get; set; }

A single aggregation result.

Not present when reporting partial progress.

Property Value
Type	Description
`AggregationResult`

Transaction

public ByteString Transaction { get; set; }

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.

Property Value
Type	Description
`ByteString`