Class: OCI::Rover::RoverClusterClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/rover/rover_cluster_client_composite_operations.rb

Overview

This class provides a wrapper around RoverClusterClient and offers convenience methods for operations that would otherwise need to be chained together. For example, instead of performing an action on a resource (e.g. launching an instance, creating a load balancer) and then using a waiter to wait for the resource to enter a given state, you can call a single method in this class to accomplish the same functionality

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_client = OCI::Rover::RoverClusterClient.new) ⇒ RoverClusterClientCompositeOperations

Initializes a new RoverClusterClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 22

def initialize(service_client = OCI::Rover::RoverClusterClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::Rover::RoverClusterClient (readonly)

The OCI::Rover::RoverClusterClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#create_rover_cluster_and_wait_for_state(create_rover_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Rover::RoverClusterClient#create_rover_cluster and then waits for the Models::RoverCluster acted upon to enter the given state(s).

Parameters:

  • create_rover_cluster_details (OCI::Rover::Models::CreateRoverClusterDetails) —

    Details for the new RoverCluster.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::RoverCluster#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Rover::RoverClusterClient#create_rover_cluster

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 41

def create_rover_cluster_and_wait_for_state(create_rover_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_rover_cluster(create_rover_cluster_details, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.data.id

  begin
    waiter_result = @service_client.get_rover_cluster(wait_for_resource_id).wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#delete_rover_cluster_and_wait_for_state(rover_cluster_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Rover::RoverClusterClient#delete_rover_cluster and then waits for the Models::RoverCluster acted upon to enter the given state(s).

Parameters:

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::RoverCluster#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Rover::RoverClusterClient#delete_rover_cluster

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 80

def delete_rover_cluster_and_wait_for_state(rover_cluster_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_rover_cluster(rover_cluster_id)
  operation_result = @service_client.delete_rover_cluster(rover_cluster_id, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)

  begin
    waiter_result = initial_get_result.wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200,
      succeed_on_not_found: true
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#request_additional_nodes_and_wait_for_state(rover_cluster_id, request_additional_nodes_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Rover::RoverClusterClient#request_additional_nodes and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

  • request_additional_nodes_details (OCI::Rover::Models::RequestAdditionalNodesDetails) —

    Details object to request additional nodes.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::WorkRequest#status

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Rover::RoverClusterClient#request_additional_nodes

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 121

def request_additional_nodes_and_wait_for_state(rover_cluster_id, request_additional_nodes_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.request_additional_nodes(rover_cluster_id, request_additional_nodes_details, base_operation_opts)
  use_util = OCI::Rover::Util.respond_to?(:wait_on_work_request)

  return operation_result if wait_for_states.empty? && !use_util

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.headers['opc-work-request-id']

  begin
    if use_util
      waiter_result = OCI::Rover::Util.wait_on_work_request(
        @service_client,
        wait_for_resource_id,
        max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
        max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
      )
    else
      waiter_result = @service_client.get_work_request(wait_for_resource_id).wait_until(
        eval_proc: ->(response) { response.data.respond_to?(:status) && lowered_wait_for_states.include?(response.data.status.downcase) },
        max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
        max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
      )
    end
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end

#update_rover_cluster_and_wait_for_state(rover_cluster_id, update_rover_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Rover::RoverClusterClient#update_rover_cluster and then waits for the Models::RoverCluster acted upon to enter the given state(s).

Parameters:

  • rover_cluster_id (String) —

    Unique RoverCluster identifier

  • update_rover_cluster_details (OCI::Rover::Models::UpdateRoverClusterDetails) —

    The information to be updated.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::RoverCluster#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::Rover::RoverClusterClient#update_rover_cluster

  • waiter_opts (Hash) (defaults to: {}) —

    Optional arguments for the waiter. Keys should be symbols, and the following keys are supported: * max_interval_seconds: The maximum interval between queries, in seconds. * max_wait_seconds The maximum time to wait, in seconds

Returns:



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/rover/rover_cluster_client_composite_operations.rb', line 171

def update_rover_cluster_and_wait_for_state(rover_cluster_id, update_rover_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_rover_cluster(rover_cluster_id, update_rover_cluster_details, base_operation_opts)

  return operation_result if wait_for_states.empty?

  lowered_wait_for_states = wait_for_states.map(&:downcase)
  wait_for_resource_id = operation_result.data.id

  begin
    waiter_result = @service_client.get_rover_cluster(wait_for_resource_id).wait_until(
      eval_proc: ->(response) { response.data.respond_to?(:lifecycle_state) && lowered_wait_for_states.include?(response.data.lifecycle_state.downcase) },
      max_interval_seconds: waiter_opts.key?(:max_interval_seconds) ? waiter_opts[:max_interval_seconds] : 30,
      max_wait_seconds: waiter_opts.key?(:max_wait_seconds) ? waiter_opts[:max_wait_seconds] : 1200
    )
    result_to_return = waiter_result

    return result_to_return
  rescue StandardError
    raise OCI::Errors::CompositeOperationError.new(partial_results: [operation_result])
  end
end