GoogleApi.Firestore.V1beta1.Model.RunQueryRequest (google_api_firestore v0.21.3) View Source

The request for Firestore.RunQuery.


  • newTransaction (type: GoogleApi.Firestore.V1beta1.Model.TransactionOptions.t, default: nil) - Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
  • readTime (type: DateTime.t, default: nil) - Reads documents as they were at the given time. This may not be older than 270 seconds.
  • structuredQuery (type: GoogleApi.Firestore.V1beta1.Model.StructuredQuery.t, default: nil) - A structured query.
  • transaction (type: String.t, default: nil) - Reads documents in a transaction.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.Firestore.V1beta1.Model.RunQueryRequest{
    GoogleApi.Firestore.V1beta1.Model.TransactionOptions.t() | nil,
  readTime: DateTime.t() | nil,
  structuredQuery: GoogleApi.Firestore.V1beta1.Model.StructuredQuery.t() | nil,
  transaction: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.