Class: Aws::Deadline::Waiters::LicenseEndpointValid

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

Overview

Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ LicenseEndpointValid

Returns a new instance of LicenseEndpointValid.

Parameters:

  • options (Hash)

Options Hash (options):

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


255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
# File 'lib/aws-sdk-deadline/waiters.rb', line 255

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 114,
    delay: 10,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_license_endpoint,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "READY"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "NOT_READY"
        }
      ]
    )
  }.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.



287
288
289
# File 'lib/aws-sdk-deadline/waiters.rb', line 287

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :license_endpoint_id (required, String)

    The license endpoint ID.

Returns:



282
283
284
# File 'lib/aws-sdk-deadline/waiters.rb', line 282

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