Class: Aws::NimbleStudio::Waiters::StreamingSessionReady

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

Overview

Wait until a StreamingSession is ready. Use this after invoking CreateStreamingSession, StartStreamingSession

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamingSessionReady

Returns a new instance of StreamingSessionReady.

Parameters:

  • options (Hash)

Options Hash (options):

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


333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/waiters.rb', line 333

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_streaming_session,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "session.state",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "session.state",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "session.state",
          "state" => "failure",
          "expected" => "START_FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :session_id (required, String) —

    The streaming session ID.

  • :studio_id (required, String) —

    The studio ID.

Returns:



366
367
368
 
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/waiters.rb', line 366

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