Class: Google::Apis::PubsubV1::CreateSnapshotRequest

Inherits:

Object

• Object
• Google::Apis::PubsubV1::CreateSnapshotRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/pubsub_v1/classes.rb,
generated/google/apis/pubsub_v1/representations.rb,
generated/google/apis/pubsub_v1/representations.rb

Overview

Request for the CreateSnapshot method.

BETA: 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.

Instance Attribute Summary

• #labels ⇒ Hash<String,String>

  See Creating and managing labels.

• #subscription ⇒ String

  The subscription whose backlog the snapshot retains.

Instance Method Summary

• #initialize(**args) ⇒ CreateSnapshotRequest constructor

  A new instance of CreateSnapshotRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreateSnapshotRequest

Returns a new instance of CreateSnapshotRequest

# File 'generated/google/apis/pubsub_v1/classes.rb', line 120

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#labels ⇒ Hash<String,String>

See Creating and managing labels. Corresponds to the JSON property labels

Returns:

• (Hash<String,String>)

# File 'generated/google/apis/pubsub_v1/classes.rb', line 105

def labels
  @labels
end

#subscription ⇒ 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`. Corresponds to the JSON propertysubscription`

Returns:

• (String)

# File 'generated/google/apis/pubsub_v1/classes.rb', line 118

def subscription
  @subscription
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/pubsub_v1/classes.rb', line 125

def update!(**args)
  @labels = args[:labels] if args.key?(:labels)
  @subscription = args[:subscription] if args.key?(:subscription)
end