Class: Aws::MediaLive::Waiters::MultiplexRunning

Inherits:

Object

• Object
• Aws::MediaLive::Waiters::MultiplexRunning

Defined in:

lib/aws-sdk-medialive/waiters.rb

Overview

Wait until a multiplex is running

Instance Attribute Summary

• #waiter ⇒ Object readonly private

Instance Method Summary

• #initialize(options) ⇒ MultiplexRunning constructor

  A new instance of MultiplexRunning.

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

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

Constructor Details

#initialize(options) ⇒ MultiplexRunning

Returns a new instance of MultiplexRunning.

Parameters:

• options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-medialive/waiters.rb', line 830

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 120,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_multiplex,
      acceptors: [
        {
          "state" => "success",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "RUNNING"
        },
        {
          "state" => "retry",
          "matcher" => "path",
          "argument" => "state",
          "expected" => "STARTING"
        },
        {
          "state" => "retry",
          "matcher" => "status",
          "expected" => 500
        }
      ]
    )
  }.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-medialive/waiters.rb', line 867

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

• #arn => String

• #availability_zones => Array<String>

• #destinations => Array<Types::MultiplexOutputDestination>

• #id => String

• #multiplex_settings => Types::MultiplexSettings

• #name => String

• #pipelines_running_count => Integer

• #program_count => Integer

• #state => String

• #tags => Hash<String,String>

Options Hash (params):

• :multiplex_id (required, String)

Returns:

• (Types::DescribeMultiplexResponse) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #availability_zones => Array<String>

  • #destinations => Array<Types::MultiplexOutputDestination>

  • #id => String

  • #multiplex_settings => Types::MultiplexSettings

  • #name => String

  • #pipelines_running_count => Integer

  • #program_count => Integer

  • #state => String

  • #tags => Hash<String,String>

# File 'lib/aws-sdk-medialive/waiters.rb', line 862

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