Class: Aws::LocationService::Waiters::JobCompleted

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ JobCompleted

Returns a new instance of JobCompleted.

Parameters:

  • options (Hash)

Options Hash (options):

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


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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 5,
    delay: 60,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "Completed"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "Failed"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "Cancelled"
        }
      ]
    )
  }.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. 



122
123
124
 
# File 'lib/aws-sdk-locationservice/waiters.rb', line 122

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :job_id (required, String) —

    The unique identifier of the job to retrieve.

Returns:



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

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