Class: Aws::Interconnect::Waiters::ConnectionAvailable

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ConnectionAvailable

Returns a new instance of ConnectionAvailable.

Parameters:

  • options (Hash)

Options Hash (options):

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


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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_connection,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "connection.state",
          "state" => "success",
          "expected" => "available"
        },
        {
          "matcher" => "path",
          "argument" => "connection.state",
          "state" => "failure",
          "expected" => "deleted"
        },
        {
          "matcher" => "path",
          "argument" => "connection.state",
          "state" => "failure",
          "expected" => "down"
        }
      ]
    )
  }.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. 



123
124
125
 
# File 'lib/aws-sdk-interconnect/waiters.rb', line 123

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :identifier (required, String) —

    The identifier of the requested Connection

Returns:



118
119
120
 
# File 'lib/aws-sdk-interconnect/waiters.rb', line 118

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