Class: Aws::Omics::Waiters::WorkflowActive

Inherits:

Object

• Object
• Aws::Omics::Waiters::WorkflowActive

Defined in:

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

Overview

Wait until a workflow is active.

Instance Method Summary

• #initialize(options) ⇒ WorkflowActive constructor

  A new instance of WorkflowActive.

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

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

Constructor Details

#initialize(options) ⇒ WorkflowActive

Returns a new instance of WorkflowActive.

Parameters:

• options (Hash)

Options Hash (options):

• :client (required, Client)
• :max_attempts (Integer) — default: 10
• :delay (Integer) — default: 3
• :before_attempt (Proc)
• :before_wait (Proc)

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

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 10,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_workflow,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "CREATING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "UPDATING"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #arn => String
• #id => String
• #status => String
• #type => String
• #name => String
• #description => String
• #engine => String
• #definition => String
• #main => String
• #digest => String
• #parameter_template => Hash<String,Types::WorkflowParameter>
• #storage_capacity => Integer
• #creation_time => Time
• #status_message => String
• #tags => Hash<String,String>
• #metadata => Hash<String,String>
• #accelerators => String

Parameters:

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

  a customizable set of options

Options Hash (params):

• :id (required, String) —

  The workflow's ID.

• :type (String) —

  The workflow's type.

• :export (Array<String>) —

  The export format for the workflow.

• :workflow_owner_id (String) —

  The ID of the workflow owner.

Returns:

• (Types::GetWorkflowResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String
  • #id => String
  • #status => String
  • #type => String
  • #name => String
  • #description => String
  • #engine => String
  • #definition => String
  • #main => String
  • #digest => String
  • #parameter_template => Hash<String,Types::WorkflowParameter>
  • #storage_capacity => Integer
  • #creation_time => Time
  • #status_message => String
  • #tags => Hash<String,String>
  • #metadata => Hash<String,String>
  • #accelerators => String

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

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