Class: Aws::MediaLive::Waiters::ChannelCreated

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

Overview

Wait until a channel has been created

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChannelCreated

Returns a new instance of ChannelCreated.

Parameters:

  • options (Hash)

Options Hash (options):

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


99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/aws-sdk-medialive/waiters.rb', line 99

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

Instance Attribute Details

#waiter ⇒ Object (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. 



142
143
144
 
# File 'lib/aws-sdk-medialive/waiters.rb', line 142

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:



137
138
139
 
# File 'lib/aws-sdk-medialive/waiters.rb', line 137

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