Module: OCI::LoadBalancer::Util

Defined in:
lib/oci/load_balancer/util.rb

Overview

Load balancer utility methods

Class Method Summary collapse

Class Method Details

.wait_on_work_request(client, work_request_id, max_interval_seconds: 30, max_wait_seconds: 1200, raise_error_on_failure: true) ⇒ WorkRequest

Wait until the work request succeeds or fails, or max_wait_seconds is reached. The work request will be polled at an increasing rate, with a maximum of max_interval_seconds between requests.

raised if the work request is in a failed state.

Parameters:

  • client (LoadBalancerClient) —

    A load balancer client

  • max_interval_seconds (Integer) (defaults to: 30) —

    The maximum interval between queries, in seconds.

  • max_wait_seconds (Integer) (defaults to: 1200) —

    The maximum total time to wait, in seconds.

  • raise_error_on_failure (Boolean) (defaults to: true) —

    If true, then a WorkRequestFailedError will be

Returns:

  • (WorkRequest) —

    The final work request



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/load_balancer/util.rb', line 17

def self.wait_on_work_request(client,
                              work_request_id,
                              max_interval_seconds: 30,
                              max_wait_seconds: 1200,
                              raise_error_on_failure: true)
  raise 'Work request ID not specified.' unless work_request_id

  interval_seconds = 1
  start_time = Time.now

  loop do
    response = client.get_work_request(work_request_id)
    lifecycle_state = response.data.lifecycle_state

    return response.data if lifecycle_state == OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_SUCCEEDED

    if response.data.lifecycle_state == OCI::LoadBalancer::Models::WorkRequest::LIFECYCLE_STATE_FAILED
      raise OCI::Errors::WorkRequestFailedError, response.data if raise_error_on_failure
      return response.data
    end

    elapsed_seconds = (Time.now - start_time).to_i

    if elapsed_seconds + interval_seconds > max_wait_seconds
      raise OCI::Errors::MaximumWaitTimeExceededError, 'Maximum wait time has been exceeded.' \
        unless max_wait_seconds > elapsed_seconds

      # Make one last request right at the maximum wait time.
      interval_seconds = max_wait_seconds - elapsed_seconds
    end

    sleep(interval_seconds)

    interval_seconds *= 2
    interval_seconds = max_interval_seconds if interval_seconds > max_interval_seconds
  end
end