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

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb

Overview

Request for the +CreateSnapshot+ method.

ALPHA: This feature is part of an alpha 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.

Instance Attribute Summary collapse

Instance Attribute Details

#labels ⇒ Hash{String => String}

Returns User labels.

Returns:

  • (Hash{String => String}) —

    User labels.



504
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 504

class CreateSnapshotRequest; end

#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}+.



504
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 504

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

Returns:

  • (String) —

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



504
 
# File 'lib/google/cloud/pubsub/v1/doc/google/pubsub/v1/pubsub.rb', line 504

class CreateSnapshotRequest; end