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

Inherits:

Object

• Object
• Aws::Deadline::Waiters::QueueScheduling

Defined in:

lib/aws-sdk-deadline/waiters.rb

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ QueueScheduling constructor

  A new instance of QueueScheduling.

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

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

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)

# 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

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

# 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:

• #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

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

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