Class: Aws::MediaConnect::Waiters::FlowActive

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

Overview

Wait until a flow is active

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FlowActive

Returns a new instance of FlowActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/aws-sdk-mediaconnect/waiters.rb', line 94

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 40,
    delay: 3,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_flow,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "retry",
          "expected" => "STARTING"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "retry",
          "expected" => "UPDATING"
        },
        {
          "matcher" => "error",
          "state" => "retry",
          "expected" => "InternalServerErrorException"
        },
        {
          "matcher" => "error",
          "state" => "retry",
          "expected" => "ServiceUnavailableException"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "failure",
          "expected" => "STANDBY"
        },
        {
          "matcher" => "path",
          "argument" => "flow.status",
          "state" => "failure",
          "expected" => "ERROR"
        }
      ]
    )
  }.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. 



154
155
156
 
# File 'lib/aws-sdk-mediaconnect/waiters.rb', line 154

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :flow_arn (required, String) —

    The ARN of the flow that you want to describe.

Returns:



149
150
151
 
# File 'lib/aws-sdk-mediaconnect/waiters.rb', line 149

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