Class: Aws::PrometheusService::Waiters::ScraperActive

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

Overview

Wait until a scraper reaches ACTIVE status

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ ScraperActive

Returns a new instance of ScraperActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 88

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_scraper,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "scraper.status.status_code",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "scraper.status.status_code",
          "state" => "failure",
          "expected" => "CREATION_FAILED"
        }
      ]
    )
  }.merge(options))
end

Instance Attribute Details

#waiterObject (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.



120
121
122
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 120

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :scraper_id (required, String)

    The ID of the scraper to describe.

Returns:



115
116
117
# File 'lib/aws-sdk-prometheusservice/waiters.rb', line 115

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