Class: Aws::NimbleStudio::Waiters::StudioComponentReady

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

Overview

Wait until a StudioComponent is Ready. Use this after invoking CreateStudioComponent or UpdateStudioComponent

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StudioComponentReady

Returns a new instance of StudioComponentReady.

Parameters:

  • options (Hash)

Options Hash (options):

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


519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 519

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_studio_component,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "studio_component.state",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "studio_component.state",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "studio_component.state",
          "state" => "failure",
          "expected" => "UPDATE_FAILED"
        }
      ]
    )
  }.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. 



557
558
559
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 557

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :studio_component_id (required, String) —

    The studio component ID.

  • :studio_id (required, String) —

    The studio ID.

Returns:



552
553
554
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 552

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