Class: OCI::OsManagementHub::DynamicSetClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb

Overview

This class provides a wrapper around DynamicSetClient 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::OsManagementHub::DynamicSetClient.new) ⇒ DynamicSetClientCompositeOperations

Initializes a new DynamicSetClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 22

def initialize(service_client = OCI::OsManagementHub::DynamicSetClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::OsManagementHub::DynamicSetClient (readonly)

The OCI::OsManagementHub::DynamicSetClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

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

Calls OCI::OsManagementHub::DynamicSetClient#create_dynamic_set and then waits for the Models::DynamicSet acted upon to enter the given state(s).

Parameters:

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/os_management_hub/dynamic_set_client_composite_operations.rb', line 41

def create_dynamic_set_and_wait_for_state(create_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_dynamic_set(create_dynamic_set_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_dynamic_set(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_dynamic_set_and_wait_for_state(dynamic_set_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#delete_dynamic_set and then waits for the Models::DynamicSet acted upon to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

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

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

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

    Any optional arguments accepted by OCI::OsManagementHub::DynamicSetClient#delete_dynamic_set

  • 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/os_management_hub/dynamic_set_client_composite_operations.rb', line 80

def delete_dynamic_set_and_wait_for_state(dynamic_set_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_dynamic_set(dynamic_set_id)
  operation_result = @service_client.delete_dynamic_set(dynamic_set_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

#install_packages_on_dynamic_set_and_wait_for_state(dynamic_set_id, install_packages_on_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#install_packages_on_dynamic_set and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

  • install_packages_on_dynamic_set_details (OCI::OsManagementHub::Models::InstallPackagesOnDynamicSetDetails) —

    Details about packages to be installed on a dynamic set.

  • 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::OsManagementHub::DynamicSetClient#install_packages_on_dynamic_set

  • 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
152
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 121

def install_packages_on_dynamic_set_and_wait_for_state(dynamic_set_id, install_packages_on_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.install_packages_on_dynamic_set(dynamic_set_id, install_packages_on_dynamic_set_details, base_operation_opts)
  use_util = OCI::OsManagementHub::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']
  return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty?

  begin
    if use_util
      waiter_result = OCI::OsManagementHub::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

#reboot_dynamic_set_and_wait_for_state(dynamic_set_id, reboot_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#reboot_dynamic_set and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

  • reboot_dynamic_set_details (OCI::OsManagementHub::Models::RebootDynamicSetDetails) —

    The timeout to be set for the reboot job. The timeout is the amount of time in minutes that the service waits for the reboot to complete before marking the job as failed.

  • 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::OsManagementHub::DynamicSetClient#reboot_dynamic_set

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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 174

def reboot_dynamic_set_and_wait_for_state(dynamic_set_id, reboot_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.reboot_dynamic_set(dynamic_set_id, reboot_dynamic_set_details, base_operation_opts)
  use_util = OCI::OsManagementHub::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']
  return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty?

  begin
    if use_util
      waiter_result = OCI::OsManagementHub::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

#remove_packages_from_dynamic_set_and_wait_for_state(dynamic_set_id, remove_packages_from_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#remove_packages_from_dynamic_set and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

  • remove_packages_from_dynamic_set_details (OCI::OsManagementHub::Models::RemovePackagesFromDynamicSetDetails) —

    Details about packages to be removed on a dynamic set.

  • 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::OsManagementHub::DynamicSetClient#remove_packages_from_dynamic_set

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 225

def remove_packages_from_dynamic_set_and_wait_for_state(dynamic_set_id, remove_packages_from_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.remove_packages_from_dynamic_set(dynamic_set_id, remove_packages_from_dynamic_set_details, base_operation_opts)
  use_util = OCI::OsManagementHub::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']
  return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty?

  begin
    if use_util
      waiter_result = OCI::OsManagementHub::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_dynamic_set_and_wait_for_state(dynamic_set_id, update_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#update_dynamic_set and then waits for the Models::DynamicSet acted upon to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

  • update_dynamic_set_details (OCI::OsManagementHub::Models::UpdateDynamicSetDetails) —

    Details to update a dynamic set.

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

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

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

    Any optional arguments accepted by OCI::OsManagementHub::DynamicSetClient#update_dynamic_set

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 276

def update_dynamic_set_and_wait_for_state(dynamic_set_id, update_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_dynamic_set(dynamic_set_id, update_dynamic_set_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_dynamic_set(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

#update_packages_on_dynamic_set_and_wait_for_state(dynamic_set_id, update_packages_on_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::OsManagementHub::DynamicSetClient#update_packages_on_dynamic_set and then waits for the Models::WorkRequest to enter the given state(s).

Parameters:

  • dynamic_set_id (String) —

    The OCID of the dynamic set. This filter returns resources associated with this dynamic set.

  • update_packages_on_dynamic_set_details (OCI::OsManagementHub::Models::UpdatePackagesOnDynamicSetDetails) —

    Details about packages to be updated on a dynamic set.

  • 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::OsManagementHub::DynamicSetClient#update_packages_on_dynamic_set

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/oci/os_management_hub/dynamic_set_client_composite_operations.rb', line 316

def update_packages_on_dynamic_set_and_wait_for_state(dynamic_set_id, update_packages_on_dynamic_set_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_packages_on_dynamic_set(dynamic_set_id, update_packages_on_dynamic_set_details, base_operation_opts)
  use_util = OCI::OsManagementHub::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']
  return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty?

  begin
    if use_util
      waiter_result = OCI::OsManagementHub::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