SnapshotArgs

data class SnapshotArgs(val labels: Output<Map<String, String>>? = null, val project: Output<String>? = null, val snapshotId: Output<String>? = null, val subscription: Output<String>? = null) : ConvertibleToJava<SnapshotArgs>

Creates a snapshot from the requested subscription. Snapshots are used in Seek 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. If the snapshot already exists, returns ALREADY_EXISTS. If the requested subscription doesn't exist, returns NOT_FOUND. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then FAILED_PRECONDITION is returned. See also the Snapshot&#46;expire_time field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the resource name format (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun SnapshotArgs(labels: Output<Map<String, String>>? = null, project: Output<String>? = null, snapshotId: Output<String>? = null, subscription: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): SnapshotArgs

Properties

Link copied to clipboard
Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val snapshotId: Output<String>? = null
Link copied to clipboard
val subscription: Output<String>? = null

The subscription whose backlog the snapshot retains. Specifically, the created snapshot is guaranteed to retain: (a) The existing backlog on the subscription. More precisely, this is defined as the messages in the subscription's backlog that are unacknowledged upon the successful completion of the CreateSnapshot request; as well as: (b) Any messages published to the subscription's topic following the successful completion of the CreateSnapshot request. Format is projects/{project}/subscriptions/{sub}.