Class: Aws::PrometheusService::Waiters::WorkspaceActive

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

Overview

Wait until a workspace reaches ACTIVE status

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ WorkspaceActive

Returns a new instance of WorkspaceActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 177

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 60,
    delay: 2,
    poller: Aws::Waiters::Poller.new(
      operation_name: :describe_workspace,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "workspace.status.status_code",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "workspace.status.status_code",
          "state" => "retry",
          "expected" => "UPDATING"
        },
        {
          "matcher" => "path",
          "argument" => "workspace.status.status_code",
          "state" => "retry",
          "expected" => "CREATING"
        }
      ]
    )
  }.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. 



215
216
217
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 215

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :workspace_id (required, String) —

    The ID of the workspace to describe.

Returns:



210
211
212
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 210

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