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

A specification of a set of documents to listen to.

Attributes

  • documents (type: GoogleApi.Firestore.V1beta1.Model.DocumentsTarget.t, default: nil) - A target specified by a set of document names.
  • once (type: boolean(), default: nil) - If the target should be removed once it is current and consistent.
  • query (type: GoogleApi.Firestore.V1beta1.Model.QueryTarget.t, default: nil) - A target specified by a query.
  • readTime (type: DateTime.t, default: nil) - Start listening after a specific read_time. The client must know the state of matching documents at this time.
  • resumeToken (type: String.t, default: nil) - A resume token from a prior TargetChange for an identical target. Using a resume token with a different target is unsupported and may fail.
  • targetId (type: integer(), default: nil) - The target ID that identifies the target on the stream. Must be a positive number and non-zero.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.Firestore.V1beta1.Model.Target{
  documents: GoogleApi.Firestore.V1beta1.Model.DocumentsTarget.t() | nil,
  once: boolean() | nil,
  query: GoogleApi.Firestore.V1beta1.Model.QueryTarget.t() | nil,
  readTime: DateTime.t() | nil,
  resumeToken: String.t() | nil,
  targetId: integer() | nil
}

Link to this section Functions

Specs

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

Unwrap a decoded JSON object into its complex fields.