Class: Google::Pubsub::V1::CreateSnapshotRequest

Inherits:

Object

Object
Google::Pubsub::V1::CreateSnapshotRequest

show all

Defined in:: lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

Request for the +CreateSnapshot+ method.

Instance Attribute Summary collapse

#name ⇒ String
Optional user-provided name for this snapshot.
#subscription ⇒ String
The subscription whose backlog the snapshot retains.

Instance Attribute Details

#name ⇒ `String`

Returns Optional user-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. Format is +projects/project/snapshots/snap+.

Returns:

(String) —
Optional user-provided name for this snapshot. 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. Note that for REST API requests, you must specify a name. Format is +projects/project/snapshots/snap+.

422	# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 422 class CreateSnapshotRequest; end

#subscription ⇒ `String`

Returns 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+.