Class: Aws::Omics::Waiters::RunCompleted

Inherits:

Object

Object
Aws::Omics::Waiters::RunCompleted

show all

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

Overview

Wait until a run is completed.

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ RunCompleted constructor

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

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

Constructor Details

#initialize(options) ⇒ `RunCompleted`

Returns a new instance of RunCompleted.

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 678

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,
      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.



734
735
736

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#arn => String
#id => String
#status => String
#workflow_id => String
#workflow_type => String
#run_id => String
#role_arn => String
#name => String
#run_group_id => String
#priority => Integer
#definition => String
#digest => String
#parameters => Hash,Array,String,Numeric,Boolean
#storage_capacity => Integer
#output_uri => String
#log_level => String
#resource_digests => Hash<String,String>
#started_by => String
#creation_time => Time
#start_time => Time
#stop_time => Time
#status_message => String
#tags => Hash<String,String>
#accelerators => String
#retention_mode => String
#failure_reason => String
#log_location => Types::RunLogLocation
#uuid => String
#run_output_uri => String
#storage_type => String
#workflow_owner_id => String

Options Hash (params):

:id (required, String) —

The run’s ID.
:export (Array<String>) —

The run’s export format.

Returns:

(Types::GetRunResponse) —
Returns a response object which responds to the following methods:
- #arn => String
- #id => String
- #status => String
- #workflow_id => String
- #workflow_type => String
- #run_id => String
- #role_arn => String
- #name => String
- #run_group_id => String
- #priority => Integer
- #definition => String
- #digest => String
- #parameters => Hash,Array,String,Numeric,Boolean
- #storage_capacity => Integer
- #output_uri => String
- #log_level => String
- #resource_digests => Hash<String,String>
- #started_by => String
- #creation_time => Time
- #start_time => Time
- #stop_time => Time
- #status_message => String
- #tags => Hash<String,String>
- #accelerators => String
- #retention_mode => String
- #failure_reason => String
- #log_location => Types::RunLogLocation
- #uuid => String
- #run_output_uri => String
- #storage_type => String
- #workflow_owner_id => String



729
730
731

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

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