Class: Aws::Deadline::Waiters::QueueSchedulingBlocked

Inherits:

Object

Object
Aws::Deadline::Waiters::QueueSchedulingBlocked

show all

Defined in:: lib/aws-sdk-deadline/waiters.rb

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ QueueSchedulingBlocked constructor

A new instance of QueueSchedulingBlocked.
#wait(params = {}) ⇒ Types::GetQueueResponse

Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ `QueueSchedulingBlocked`

Returns a new instance of QueueSchedulingBlocked.

Parameters:

options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-deadline/waiters.rb', line 372

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



396
397
398

# File 'lib/aws-sdk-deadline/waiters.rb', line 396

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

#queue_id => String
#display_name => String
#description => String
#farm_id => String
#status => String
#default_budget_action => String
#blocked_reason => String
#job_attachment_settings => Types::JobAttachmentSettings
#role_arn => String
#required_file_system_location_names => Array<String>
#allowed_storage_profile_ids => Array<String>
#job_run_as_user => Types::JobRunAsUser
#created_at => Time
#created_by => String
#updated_at => Time
#updated_by => String

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:

(Types::GetQueueResponse) —
Returns a response object which responds to the following methods:
- #queue_id => String
- #display_name => String
- #description => String
- #farm_id => String
- #status => String
- #default_budget_action => String
- #blocked_reason => String
- #job_attachment_settings => Types::JobAttachmentSettings
- #role_arn => String
- #required_file_system_location_names => Array<String>
- #allowed_storage_profile_ids => Array<String>
- #job_run_as_user => Types::JobRunAsUser
- #created_at => Time
- #created_by => String
- #updated_at => Time
- #updated_by => String



391
392
393

# File 'lib/aws-sdk-deadline/waiters.rb', line 391

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