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

Targets being watched have changed.

Attributes

cause (type: GoogleApi.Firestore.V1.Model.Status.t, default: nil) - The error that resulted in this change, if applicable.
readTime (type: DateTime.t, default: nil) - The consistent read_time for the given target_ids (omitted when the target_ids are not at a consistent snapshot).

The stream is guaranteed to send a read_time with target_ids empty whenever the entire stream reaches a new consistent snapshot. ADD, CURRENT, and RESET messages are guaranteed to (eventually) result in a new consistent snapshot (while NO_CHANGE and REMOVE messages are not).

For a given stream, read_time is guaranteed to be monotonically increasing.
resumeToken (type: String.t, default: nil) - A token that can be used to resume the stream for the given target_ids, or all targets if target_ids is empty.

Not set on every target change.
targetChangeType (type: String.t, default: nil) - The type of change that occurred.
targetIds (type: list(integer()), default: nil) - The target IDs of targets that have changed.

If empty, the change applies to all targets.

For target_change_type=ADD, the order of the target IDs matches the order of the requests to add the targets. This allows clients to unambiguously associate server-assigned target IDs with added targets.

For other states, the order of the target IDs is not defined.

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.TargetChange{
  cause: GoogleApi.Firestore.V1.Model.Status.t(),
  readTime: DateTime.t(),
  resumeToken: String.t(),
  targetChangeType: String.t(),
  targetIds: [integer()]
}

Link to this section Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.