Class: Aws::Deadline::Waiters::QueueScheduling

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ QueueScheduling

Returns a new instance of QueueScheduling.

Parameters:

  • options (Hash)

Options Hash (options):

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


336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/aws-sdk-deadline/waiters.rb', line 336

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 70,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_queue,
      acceptors: [{
        "matcher" => "path",
        "argument" => "status",
        "state" => "success",
        "expected" => "SCHEDULING"
      }]
    )
  }.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.



360
361
362
# File 'lib/aws-sdk-deadline/waiters.rb', line 360

def waiter
  @waiter
end

Instance Method Details

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

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

  • :queue_id (required, String)

    The queue ID for the queue to retrieve.

Returns:



355
356
357
# File 'lib/aws-sdk-deadline/waiters.rb', line 355

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