View Source GoogleApi.Firestore.V1.Model.RunAggregationQueryResponse (google_api_firestore v0.27.0)

The response for Firestore.RunAggregationQuery.

Attributes

explainMetrics (type: GoogleApi.Firestore.V1.Model.ExplainMetrics.t, default: nil) - 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.
readTime (type: DateTime.t, default: nil) - 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.
result (type: GoogleApi.Firestore.V1.Model.AggregationResult.t, default: nil) - A single aggregation result. Not present when reporting partial progress.
transaction (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.RunAggregationQueryResponse{
  explainMetrics: GoogleApi.Firestore.V1.Model.ExplainMetrics.t() | nil,
  readTime: DateTime.t() | nil,
  result: GoogleApi.Firestore.V1.Model.AggregationResult.t() | nil,
  transaction: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.