Class: Aws::NimbleStudio::Waiters::StreamingSessionStreamReady

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

Overview

Wait until a StreamingSessionStream is ready. Use this after invoking CreateStreamingSessionStream

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamingSessionStreamReady

Returns a new instance of StreamingSessionStreamReady.

Parameters:

  • options (Hash)

Options Hash (options):

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


429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 429

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 30,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_streaming_session_stream,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "stream.state",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "stream.state",
          "state" => "failure",
          "expected" => "CREATE_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. 



461
462
463
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 461

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

  • #stream => Types::StreamingSessionStream

Options Hash (params):

  • :session_id (required, String) —

    The streaming session ID.

  • :stream_id (required, String) —

    The streaming session stream ID.

  • :studio_id (required, String) —

    The studio ID.

Returns:



456
457
458
 
# File 'lib/aws-sdk-nimblestudio/waiters.rb', line 456

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