class Aws::Resources::Documenter::WaiterOperationDocumenter

Public Instance Methods

api_request() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 46
def api_request
  @resource_class.client_class.api.operation(api_request_name)
end
api_request_name() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 50
def api_request_name
  waiter.poller.operation_name
end
docstring() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 6
        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
example_tags() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 58
        def example_tags
          example = "@example Basic usage
  #{variable_name}.#{operation_name}

@example Modify default configuration
  #{variable_name}.#{operation_name} do |w|
     w.interval = 10
     w.max_attempts = 100
     w.before_attempt { |count| ... }
     w.before_wait do { |count, prev_resp| ... }
  end
".strip
          [tag(example)]
        end
option_tags() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 54
def option_tags
  []
end
return_message() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 30
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
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 26
def return_tag
  tag("@return [#{resource_class_name}] #{return_message}")
end
state() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 38
def state
  operation_name.to_s.sub('wait_until_', '')
end
waiter() click to toggle source
# File lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb, line 42
def waiter
  @resource_class.client_class.waiters.waiter(@operation.waiter_name)
end