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) 


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 274

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. 



312
313
314
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 312

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:



307
308
309
 
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 307

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