Class: Aws::MediaLive::Waiters::ChannelDeleted

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-medialive/waiters.rb

Overview

Wait until a channel has been deleted

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChannelDeleted

Returns a new instance of ChannelDeleted.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 84
  • :delay (Integer) — default: 5
  • :before_attempt (Proc)
  • :before_wait (Proc)


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
# File 'lib/aws-sdk-medialive/waiters.rb', line 155

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 84,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_channel,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DELETED"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "DELETING"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



192
193
194
# File 'lib/aws-sdk-medialive/waiters.rb', line 192

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ Types::DescribeChannelResponse

Returns a response object which responds to the following methods:

Options Hash (params):

  • :channel_id (required, String)

Returns:



187
188
189
# File 'lib/aws-sdk-medialive/waiters.rb', line 187

def wait(params = {})
  @waiter.wait(client: @client, params: params)
end