google_api_pub_sub v0.4.0 GoogleApi.PubSub.V1.Model.Snapshot View Source

A snapshot resource. Snapshots are used in <a href="https://cloud.google.com/pubsub/docs/replay-overview">Seek</a> operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot.<br><br> <b>BETA:</b> This feature is part of a beta release. This API might be changed in backward-incompatible ways and is not recommended for production use. It is not subject to any SLA or deprecation policy.

Attributes

  • expireTime (DateTime.t): The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. Defaults to: null.
  • labels (%{optional(String.t) => String.t}): See <a href="https://cloud.google.com/pubsub/docs/labels"> Creating and managing labels</a>. Defaults to: null.
  • name (String.t): The name of the snapshot. Defaults to: null.
  • topic (String.t): The name of the topic from which this snapshot is retaining messages. Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.PubSub.V1.Model.Snapshot{
  expireTime: DateTime.t(),
  labels: map(),
  name: any(),
  topic: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.