Class: Aws::Omics::Waiters::AnnotationImportJobCreated

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

Overview

Wait until an annotation import is completed

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ AnnotationImportJobCreated

Returns a new instance of AnnotationImportJobCreated.

Parameters:

  • options (Hash)

Options Hash (options):

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


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/aws-sdk-omics/waiters.rb', line 101

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_annotation_import_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "SUBMITTED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "retry",
          "expected" => "IN_PROGRESS"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "CANCELLED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "COMPLETED"
        }
      ]
    )
  }.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. 



151
152
153
 
# File 'lib/aws-sdk-omics/waiters.rb', line 151

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :job_id (required, String) —

    The job’s ID.

Returns:



146
147
148
 
# File 'lib/aws-sdk-omics/waiters.rb', line 146

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