Class: Aws::Kinesis::Waiters::ChannelActive

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

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ChannelActive

Returns a new instance of ChannelActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


86
87
88
89
90
91
92
93
94
95
96
97
98
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
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 86

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 18,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_channel,
      acceptors: [
        {
          "expected" => "ACTIVE",
          "matcher" => "path",
          "state" => "success",
          "argument" => "channel_description.channel_status"
        },
        {
          "expected" => "CREATING",
          "matcher" => "path",
          "state" => "retry",
          "argument" => "channel_description.channel_status"
        },
        {
          "expected" => "UPDATING",
          "matcher" => "path",
          "state" => "retry",
          "argument" => "channel_description.channel_status"
        },
        {
          "expected" => "DELETING",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "channel_description.channel_status"
        },
        {
          "expected" => "FAILED",
          "matcher" => "path",
          "state" => "failure",
          "argument" => "channel_description.channel_status"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :channel_arn (required, String) —

    The Amazon Resource Name (ARN) of the channel to describe.

Returns:



131
132
133
 
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/waiters.rb', line 131

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