Class: Aws::GameLiftStreams::Waiters::ApplicationReady

Inherits:

Object

Object
Aws::GameLiftStreams::Waiters::ApplicationReady

show all

Defined in:: lib/aws-sdk-gameliftstreams/waiters.rb

Overview

Waits until an application is ready

Instance Attribute Summary collapse

#waiter ⇒ Object readonly private

Instance Method Summary collapse

#initialize(options) ⇒ ApplicationReady constructor

A new instance of ApplicationReady.
#wait(params = {}) ⇒ Types::GetApplicationOutput

Returns a response object which responds to the following methods:.

Constructor Details

#initialize(options) ⇒ `ApplicationReady`

Returns a new instance of ApplicationReady.

Parameters:

options (Hash)

Options Hash (options):

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

# File 'lib/aws-sdk-gameliftstreams/waiters.rb', line 125

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



157
158
159

# File 'lib/aws-sdk-gameliftstreams/waiters.rb', line 157

def waiter
  @waiter
end

Instance Method Details

#wait(params = {}) ⇒ `Types::GetApplicationOutput`

Returns a response object which responds to the following methods:

#arn => String
#description => String
#runtime_environment => Types::RuntimeEnvironment
#executable_path => String
#application_log_paths => Array<String>
#application_log_output_uri => String
#application_source_uri => String
#id => String
#status => String
#status_reason => String
#replication_statuses => Array<Types::ReplicationStatus>
#created_at => Time
#last_updated_at => Time
#associated_stream_groups => Array<String>

Options Hash (params):

:identifier (required, String) —

An [Amazon Resource Name (ARN)] or ID that uniquely identifies the application resource. Example ARN: ‘arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`. Example ID: `a-9ZY8X7Wv6`.

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html

Returns:

(Types::GetApplicationOutput) —
Returns a response object which responds to the following methods:
- #arn => String
- #description => String
- #runtime_environment => Types::RuntimeEnvironment
- #executable_path => String
- #application_log_paths => Array<String>
- #application_log_output_uri => String
- #application_source_uri => String
- #id => String
- #status => String
- #status_reason => String
- #replication_statuses => Array<Types::ReplicationStatus>
- #created_at => Time
- #last_updated_at => Time
- #associated_stream_groups => Array<String>



152
153
154

# File 'lib/aws-sdk-gameliftstreams/waiters.rb', line 152

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