Class: Aws::Omics::Waiters::TaskCompleted

Inherits:

Object

Object
Aws::Omics::Waiters::TaskCompleted

show all

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

Overview

Wait until a task is completed.

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ TaskCompleted constructor

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

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

Constructor Details

#initialize(options) ⇒ `TaskCompleted`

Returns a new instance of TaskCompleted.

Parameters:

options (Hash)

Options Hash (options):

:client (required, Client)
:max_attempts (Integer) — default: 20
:delay (Integer) — default: 30
:before_attempt (Proc)
:before_wait (Proc)

# File 'lib/aws-sdk-omics/waiters.rb', line 810

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 20,
    delay: 30,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_run_task,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "COMPLETED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "PENDING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "STARTING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "RUNNING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "STOPPING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        }
      ]
    )
  }.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.



866
867
868

# File 'lib/aws-sdk-omics/waiters.rb', line 866

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#task_id => String
#status => String
#name => String
#cpus => Integer
#memory => Integer
#creation_time => Time
#start_time => Time
#stop_time => Time
#status_message => String
#log_stream => String
#gpus => Integer
#instance_type => String
#failure_reason => String

Options Hash (params):

:id (required, String) —

The workflow run ID.
:task_id (required, String) —

The task’s ID.

Returns:

(Types::GetRunTaskResponse) —
Returns a response object which responds to the following methods:
- #task_id => String
- #status => String
- #name => String
- #cpus => Integer
- #memory => Integer
- #creation_time => Time
- #start_time => Time
- #stop_time => Time
- #status_message => String
- #log_stream => String
- #gpus => Integer
- #instance_type => String
- #failure_reason => String



861
862
863

# File 'lib/aws-sdk-omics/waiters.rb', line 861

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