api_request()
click to toggle source
def api_request
@resource_class.client_class.api.operation(api_request_name)
end
api_request_name()
click to toggle source
def api_request_name
waiter.poller.operation_name
end
docstring()
click to toggle source
def docstring
super + ' ' + "Waits until this #{resource_class_name} is #{state}. This method
waits by polling {Client##{api_request_name}} until successful. An error is
raised after a configurable number of failed checks.
This waiter uses the following defaults:
| Configuration | Default |
|-----------------|------------------------|
| `#delay` | #{waiter.delay} |
| `#max_attempts` | #{waiter.max_attempts} |
You can modify defaults and register callbacks by passing a block argument.
@yieldparam [Waiters::Waiter] waiter
@raise [Waiters::Errors::WaiterFailed]
@see Client#wait_until
".lstrip
end
return_message()
click to toggle source
def return_message
if @operation.path
"Returns a copy of this #{resource_class_name} with loaded data."
else
"Returns a copy of this #{resource_class_name} that is not loaded."
end
end
return_tag()
click to toggle source
def return_tag
tag("@return [#{resource_class_name}] #{return_message}")
end
state()
click to toggle source
def state
operation_name.to_s.sub('wait_until_', '')
end
waiter()
click to toggle source
def waiter
@resource_class.client_class.waiters.waiter(@operation.waiter_name)
end