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

Inherits:

Object

• Object
• Aws::LocationService::Waiters::JobCompleted

Defined in:

gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/waiters.rb

Instance Method Summary

• #initialize(options) ⇒ JobCompleted constructor

  A new instance of JobCompleted.

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

  Returns a response object which responds to the following methods:.

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)

# File 'gems/aws-sdk-locationservice/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 Method Details

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

Returns a response object which responds to the following methods:

• #action => String
• #action_options => Types::JobActionOptions
• #created_at => Time
• #ended_at => Time
• #error => Types::JobError
• #execution_role_arn => String
• #input_options => Types::JobInputOptions
• #job_arn => String
• #job_id => String
• #name => String
• #output_options => Types::JobOutputOptions
• #status => String
• #updated_at => Time
• #tags => Hash<String,String>

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :job_id (required, String) —

  The unique identifier of the job to retrieve.

Returns:

• (Types::GetJobResponse) —

  Returns a response object which responds to the following methods:

  • #action => String
  • #action_options => Types::JobActionOptions
  • #created_at => Time
  • #ended_at => Time
  • #error => Types::JobError
  • #execution_role_arn => String
  • #input_options => Types::JobInputOptions
  • #job_arn => String
  • #job_id => String
  • #name => String
  • #output_options => Types::JobOutputOptions
  • #status => String
  • #updated_at => Time
  • #tags => Hash<String,String>

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

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