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

The request for Firestore.RunAggregationQuery.

Attributes

explainOptions (type: GoogleApi.Firestore.V1.Model.ExplainOptions.t, default: nil) - Optional. Explain options for the query. If set, additional query statistics will be returned. If not, only query results will be returned.
newTransaction (type: GoogleApi.Firestore.V1.Model.TransactionOptions.t, default: nil) - Starts a new transaction as part of the query, defaulting to read-only. The new transaction ID will be returned as the first response in the stream.
readTime (type: DateTime.t, default: nil) - Executes the query at the given timestamp. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
structuredAggregationQuery (type: GoogleApi.Firestore.V1.Model.StructuredAggregationQuery.t, default: nil) - An aggregation query.
transaction (type: String.t, default: nil) - Run the aggregation within an already active transaction. The value here is the opaque transaction ID to execute the query in.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Firestore.V1.Model.RunAggregationQueryRequest{
  explainOptions: GoogleApi.Firestore.V1.Model.ExplainOptions.t() | nil,
  newTransaction: GoogleApi.Firestore.V1.Model.TransactionOptions.t() | nil,
  readTime: DateTime.t() | nil,
  structuredAggregationQuery:
    GoogleApi.Firestore.V1.Model.StructuredAggregationQuery.t() | nil,
  transaction: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.