Class: Aws::Repostspace::Waiters::ChannelCreated

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

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: 60
  • :delay (Integer) — default: 2
  • :before_attempt (Proc)
  • :before_wait (Proc) 


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
 
# File 'lib/aws-sdk-repostspace/waiters.rb', line 87

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_channel,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "channel_status",
          "state" => "success",
          "expected" => "CREATED"
        },
        {
          "matcher" => "path",
          "argument" => "channel_status",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "channel_status",
          "state" => "retry",
          "expected" => "CREATING"
        }
      ]
    )
  }.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. 



125
126
127
 
# File 'lib/aws-sdk-repostspace/waiters.rb', line 125

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :space_id (required, String) —

    The unique ID of the private re:Post.

  • :channel_id (required, String) —

    The unique ID of the private re:Post channel.

Returns:



120
121
122
 
# File 'lib/aws-sdk-repostspace/waiters.rb', line 120

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