Class: Aws::Deadline::Waiters::QueueLimitAssociationStopped

Inherits:

Object

• Object
• Aws::Deadline::Waiters::QueueLimitAssociationStopped

Defined in:

lib/aws-sdk-deadline/waiters.rb

Overview

Wait until a QueueLimitAssociation is stopped. Use this after setting the status to STOP_LIMIT_USAGE_AND_COMPLETE_TASKS or STOP_LIMIT_USAGE_AND_CANCEL_TASKS to wait for a QueueLimitAssociation to reach STOPPED

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ QueueLimitAssociationStopped constructor

  A new instance of QueueLimitAssociationStopped.

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

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

Constructor Details

#initialize(options) ⇒ QueueLimitAssociationStopped

Returns a new instance of QueueLimitAssociationStopped.

Parameters:

• options (Hash)

Options Hash (options):

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

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

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

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #created_at => Time

• #created_by => String

• #updated_at => Time

• #updated_by => String

• #queue_id => String

• #limit_id => String

• #status => String

Options Hash (params):

• :farm_id (required, String) —

  The unique identifier of the farm that contains the associated queue and limit.

• :queue_id (required, String) —

  The unique identifier of the queue associated with the limit.

• :limit_id (required, String) —

  The unique identifier of the limit associated with the queue.

Returns:

• (Types::GetQueueLimitAssociationResponse) —

  Returns a response object which responds to the following methods:

  • #created_at => Time

  • #created_by => String

  • #updated_at => Time

  • #updated_by => String

  • #queue_id => String

  • #limit_id => String

  • #status => String

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

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