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

Inherits:
Object
  • Object
show all
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.

Instance Attribute Summary collapse

Instance Method Summary collapse

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.


136
137
138
# File 'generated/google/apis/pubsub_v1/classes.rb', line 136

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

Instance Attribute Details

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

def labels
  @labels
end

#subscriptionString

Required. 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)

134
135
136
# File 'generated/google/apis/pubsub_v1/classes.rb', line 134

def subscription
  @subscription
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


141
142
143
144
# File 'generated/google/apis/pubsub_v1/classes.rb', line 141

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