google_api_firestore v0.9.0 GoogleApi.Firestore.V1.Model.Target View Source

A specification of a set of documents to listen to.

Attributes

documents (type: GoogleApi.Firestore.V1.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.V1.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) - A client provided target ID.

If not set, the server will assign an ID for the target.

Used for resuming a target without changing IDs. The IDs can either be client-assigned or be server-assigned in a previous stream. All targets with client provided IDs must be added before adding a target that needs a server-assigned id.

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

t()

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

Link to this section Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.