You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Resources::Documenter::WaiterOperationDocumenter

Inherits:
BaseOperationDocumenter show all
Defined in:
aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb

Instance Attribute Summary

Attributes inherited from BaseOperationDocumenter

#api_request_params, #builder, #called_operation, #operation_name, #resource_class, #resource_class_name, #source, #target_resource_class, #target_resource_class_name, #yard_class

Instance Method Summary collapse

Methods inherited from BaseOperationDocumenter

#initialize, #method_object

Constructor Details

This class inherits a constructor from Aws::Resources::Documenter::BaseOperationDocumenter

Instance Method Details

#api_request ⇒ Object 



46
47
48
 
# File 'aws-sdk-resources/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 ⇒ Object 



50
51
52
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 50

def api_request_name
  waiter.poller.operation_name
end

#docstring ⇒ Object 



6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 6

def docstring
  super + ' ' + <<-DOCSTRING.lstrip
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
  DOCSTRING
end

#example_tags ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 58

def example_tags
  example = <<-EXAMPLE.strip
@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
  EXAMPLE
  [tag(example)]
end

#option_tags ⇒ Object 



54
55
56
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 54

def option_tags
  []
end

#return_message ⇒ Object 



30
31
32
33
34
35
36
 
# File 'aws-sdk-resources/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 ⇒ Object 



26
27
28
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 26

def return_tag
  tag("@return [#{resource_class_name}] #{return_message}")
end

#state ⇒ Object 



38
39
40
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 38

def state
  operation_name.to_s.sub('wait_until_', '')
end

#waiter ⇒ Object 



42
43
44
 
# File 'aws-sdk-resources/lib/aws-sdk-resources/documenter/waiter_operation_documenter.rb', line 42

def waiter
  @resource_class.client_class.waiters.waiter(@operation.waiter_name)
end