Class: Aws::Transfer::Waiters::ServerOffline

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ServerOffline

Returns a new instance of ServerOffline.

Parameters:

  • options (Hash)

Options Hash (options):

  • :client (required, Client)
  • :max_attempts (Integer) — default: 120
  • :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
 
# File 'lib/aws-sdk-transfer/waiters.rb', line 85

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_server,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "server.state",
          "state" => "success",
          "expected" => "OFFLINE"
        },
        {
          "matcher" => "path",
          "argument" => "server.state",
          "state" => "failure",
          "expected" => "STOP_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. 



117
118
119
 
# File 'lib/aws-sdk-transfer/waiters.rb', line 117

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

  • #server => Types::DescribedServer

Options Hash (params):

  • :server_id (required, String) —

    A system-assigned unique identifier for a server.

Returns:



112
113
114
 
# File 'lib/aws-sdk-transfer/waiters.rb', line 112

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