Class: Aws::Deadline::Waiters::FleetActive

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

Overview

Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ FleetActive

Returns a new instance of FleetActive.

Parameters:

  • options (Hash)

Options Hash (options):

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


91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/aws-sdk-deadline/waiters.rb', line 91

def initialize(options)
  @client = options.fetch(:client)
  @waiter = Aws::Waiters::Waiter.new({
    max_attempts: 180,
    delay: 5,
    poller: Aws::Waiters::Poller.new(
      operation_name: :get_fleet,
      acceptors: [
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "success",
          "expected" => "ACTIVE"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "CREATE_FAILED"
        },
        {
          "matcher" => "path",
          "argument" => "status",
          "state" => "failure",
          "expected" => "UPDATE_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.



129
130
131
# File 'lib/aws-sdk-deadline/waiters.rb', line 129

def waiter
  @waiter
end

Instance Method Details

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

Returns a response object which responds to the following methods:

Options Hash (params):

  • :farm_id (required, String)

    The farm ID of the farm in the fleet.

  • :fleet_id (required, String)

    The fleet ID of the fleet to get.

Returns:



124
125
126
# File 'lib/aws-sdk-deadline/waiters.rb', line 124

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