Class: OCI::Core::ComputeManagementClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/compute_management_client_composite_operations.rb

Overview

This class provides a wrapper around ComputeManagementClient 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::Core::ComputeManagementClient.new) ⇒ ComputeManagementClientCompositeOperations

Initializes a new ComputeManagementClientCompositeOperations

Parameters:



19
20
21
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 19

def initialize(service_client = OCI::Core::ComputeManagementClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::Core::ComputeManagementClient (readonly)

The OCI::Core::ComputeManagementClient used to communicate with the service_client

Returns:



13
14
15
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 13

def service_client
  @service_client
end

Instance Method Details

#attach_load_balancer_and_wait_for_state(instance_pool_id, attach_load_balancer_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Core::ComputeManagementClient#attach_load_balancer and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

  • attach_load_balancer_details (OCI::Core::Models::AttachLoadBalancerDetails) —

    Load balancer being attached

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#attach_load_balancer

  • 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:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 39

def attach_load_balancer_and_wait_for_state(instance_pool_id, attach_load_balancer_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.attach_load_balancer(instance_pool_id, attach_load_balancer_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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#create_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

Returns:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 78

def create_instance_pool_and_wait_for_state(create_instance_pool_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_instance_pool(create_instance_pool_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_instance_pool(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

#detach_load_balancer_and_wait_for_state(instance_pool_id, detach_load_balancer_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Core::ComputeManagementClient#detach_load_balancer and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

  • detach_load_balancer_details (OCI::Core::Models::DetachLoadBalancerDetails) —

    Load balancer being detached

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#detach_load_balancer

  • 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:



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 118

def detach_load_balancer_and_wait_for_state(instance_pool_id, detach_load_balancer_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.detach_load_balancer(instance_pool_id, detach_load_balancer_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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#reset_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#reset_instance_pool

  • 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:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 157

def reset_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.reset_instance_pool(instance_pool_id, 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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#softreset_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#softreset_instance_pool

  • 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:



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 196

def softreset_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.softreset_instance_pool(instance_pool_id, 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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#start_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#start_instance_pool

  • 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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 235

def start_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.start_instance_pool(instance_pool_id, 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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#stop_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#stop_instance_pool

  • 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:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 274

def stop_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.stop_instance_pool(instance_pool_id, 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_instance_pool(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

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

Calls OCI::Core::ComputeManagementClient#terminate_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#terminate_instance_pool

  • 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:



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 313

def terminate_instance_pool_and_wait_for_state(instance_pool_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_instance_pool(instance_pool_id)
  operation_result = @service_client.terminate_instance_pool(instance_pool_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

#update_instance_pool_and_wait_for_state(instance_pool_id, update_instance_pool_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::Core::ComputeManagementClient#update_instance_pool and then waits for the Models::InstancePool acted upon to enter the given state(s).

Parameters:

  • instance_pool_id (String) —

    The OCID of the instance pool.

  • update_instance_pool_details (OCI::Core::Models::UpdateInstancePoolDetails) —

    Update instance pool configuration

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

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

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

    Any optional arguments accepted by OCI::Core::ComputeManagementClient#update_instance_pool

  • 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:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/core/compute_management_client_composite_operations.rb', line 354

def update_instance_pool_and_wait_for_state(instance_pool_id, update_instance_pool_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_instance_pool(instance_pool_id, update_instance_pool_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_instance_pool(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