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

Inherits:

Object

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

Defined in:

lib/aws-sdk-omics/waiters.rb

Overview

Wait until a workflow is active.

Instance Attribute Summary

• #waiter ⇒ Object readonly private

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 'lib/aws-sdk-omics/waiters.rb', line 1113

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

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

def waiter
  @waiter
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

• #storage_type => String

• #uuid => String

• #container_registry_map => Types::ContainerRegistryMap

• #readme => String

• #definition_repository_details => Types::DefinitionRepositoryDetails

• #readme_path => String

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&lt;String,Types::WorkflowParameter&gt;

  • #storage_capacity => Integer

  • #creation_time => Time

  • #status_message => String

  • #tags => Hash&lt;String,String&gt;

  • #metadata => Hash&lt;String,String&gt;

  • #accelerators => String

  • #storage_type => String

  • #uuid => String

  • #container_registry_map => Types::ContainerRegistryMap

  • #readme => String

  • #definition_repository_details => Types::DefinitionRepositoryDetails

  • #readme_path => String

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

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