Class: Aws::NimbleStudio::Waiters::StreamingImageReady

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

Overview

Wait until a StreamingImage is Ready. Use this after invoking CreateStreamingImage or UpdateStreamingImage

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ StreamingImageReady

Returns a new instance of StreamingImageReady.

Parameters:

  • options (Hash)

Options Hash (options):

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


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/waiters.rb', line 237

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_streaming_image,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "streaming_image.state",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "streaming_image.state",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "streaming_image.state",
          "state" => "failure",
          "expected" => "UPDATE_FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Parameters:

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

    a customizable set of options

Options Hash (params):

  • :streaming_image_id (required, String)

    The streaming image ID.

  • :studio_id (required, String)

    The studio ID.

Returns:



270
271
272
# File 'gems/aws-sdk-nimblestudio/lib/aws-sdk-nimblestudio/waiters.rb', line 270

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