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

Inherits:
Object
  • Object
show all
Defined in:
lib/aws-sdk-omics/waiters.rb

Overview

Wait until a workflow is active.

Instance Attribute Summary collapse

Instance Method Summary collapse

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)


1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
# File '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 Attribute Details

#waiterObject (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.



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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

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:



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

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