Class: Aws::Deadline::Waiters::JobSucceeded

Inherits:

Object

• Object
• Aws::Deadline::Waiters::JobSucceeded

Defined in:

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

Overview

Wait until a job has succeeded. Fails if the job reaches a non-successful terminal status. Waits up to 1 hour by default.

Instance Method Summary

• #initialize(options) ⇒ JobSucceeded constructor

  A new instance of JobSucceeded.

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

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

Constructor Details

#initialize(options) ⇒ JobSucceeded

Returns a new instance of JobSucceeded.

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 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/waiters.rb', line 283

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" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "failure",
          "expected" => "CANCELED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "failure",
          "expected" => "SUSPENDED"
        },
        {
          "matcher" => "path",
          "argument" => "task_run_status",
          "state" => "failure",
          "expected" => "NOT_COMPATIBLE"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "failure",
          "expected" => "ARCHIVED"
        }
      ]
    )
  }.merge(options))
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

Parameters:

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

  a customizable set of options

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

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

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