Class: Aws::Deadline::Waiters::JobCreateComplete

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

Overview

Wait until a Job is created. Use this after invoking CreateJob.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ JobCreateComplete

Returns a new instance of JobCreateComplete.

Parameters:

  • options (Hash)

Options Hash (options):

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


142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/aws-sdk-deadline/waiters.rb', line 142

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 1,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_job,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "success",
          "expected" => "CREATE_COMPLETE"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "success",
          "expected" => "UPDATE_IN_PROGRESS"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "success",
          "expected" => "UPDATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "success",
          "expected" => "UPDATE_SUCCEEDED"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "failure",
          "expected" => "UPLOAD_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "lifecycle_status",
          "state" => "failure",
          "expected" => "CREATE_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.



198
199
200
# File 'lib/aws-sdk-deadline/waiters.rb', line 198

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :farm_id (required, String)

    The farm ID of the farm in the job.

  • :job_id (required, String)

    The job ID.

  • :queue_id (required, String)

    The queue ID associated with the job.

Returns:



193
194
195
# File 'lib/aws-sdk-deadline/waiters.rb', line 193

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