Class: Aws::Deadline::Waiters::JobComplete

Inherits:

Object

Object
Aws::Deadline::Waiters::JobComplete

show all

Defined in:: lib/aws-sdk-deadline/waiters.rb

Overview

Wait until a job reaches any terminal status. Waits up to 1 hour by default.

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ JobComplete constructor

A new instance of JobComplete.
#wait(params = {}) ⇒ Types::GetJobResponse

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

Constructor Details

#initialize(options) ⇒ `JobComplete`

Returns a new instance of JobComplete.

Parameters:

options (Hash)

Options Hash (options):

:client (required, Client)
:max_attempts (Integer) — default: 240
:delay (Integer) — default: 15
:before_attempt (Proc)
:before_wait (Proc)

# File 'lib/aws-sdk-deadline/waiters.rb', line 145

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 240,
    delay: 15,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "success",
          "expected" => "SUCCEEDED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "success",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "success",
          "expected" => "CANCELED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "success",
          "expected" => "SUSPENDED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "success",
          "expected" => "NOT_COMPATIBLE"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "success",
          "expected" => "ARCHIVED"
        }
      ]
    )
  }.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.



201
202
203

# File 'lib/aws-sdk-deadline/waiters.rb', line 201

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#job_id => String
#name => String
#lifecycle_status => String
#lifecycle_status_message => String
#priority => Integer
#created_at => Time
#created_by => String
#updated_at => Time
#updated_by => String
#started_at => Time
#ended_at => Time
#task_run_status => String
#target_task_run_status => String
#task_run_status_counts => Hash<String,Integer>
#task_failure_retry_count => Integer
#storage_profile_id => String
#max_failed_tasks_count => Integer
#max_retries_per_task => Integer
#parameters => Hash<String,Types::JobParameter>
#attachments => Types::Attachments
#description => String
#max_worker_count => Integer
#source_job_id => String

Options Hash (params):

:farm_id (required, String) —

The farm ID of the farm in the job.
:queue_id (required, String) —

The queue ID associated with the job.
:job_id (required, String) —

The job ID.

Returns:

(Types::GetJobResponse) —
Returns a response object which responds to the following methods:
- #job_id => String
- #name => String
- #lifecycle_status => String
- #lifecycle_status_message => String
- #priority => Integer
- #created_at => Time
- #created_by => String
- #updated_at => Time
- #updated_by => String
- #started_at => Time
- #ended_at => Time
- #task_run_status => String
- #target_task_run_status => String
- #task_run_status_counts => Hash<String,Integer>
- #task_failure_retry_count => Integer
- #storage_profile_id => String
- #max_failed_tasks_count => Integer
- #max_retries_per_task => Integer
- #parameters => Hash<String,Types::JobParameter>
- #attachments => Types::Attachments
- #description => String
- #max_worker_count => Integer
- #source_job_id => String



196
197
198

# File 'lib/aws-sdk-deadline/waiters.rb', line 196

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