Class: OCI::ManagementAgent::ManagementAgentClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/management_agent/management_agent_client_composite_operations.rb

Overview

This class provides a wrapper around ManagementAgentClient 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::ManagementAgent::ManagementAgentClient.new) ⇒ ManagementAgentClientCompositeOperations

Initializes a new ManagementAgentClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 22

def initialize(service_client = OCI::ManagementAgent::ManagementAgentClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::ManagementAgent::ManagementAgentClient (readonly)

The OCI::ManagementAgent::ManagementAgentClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#create_data_source_and_wait_for_state(management_agent_id, create_data_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::ManagementAgent::ManagementAgentClient#create_data_source and then waits for the OCI::ManagementAgent::Models::WorkRequest to enter the given state(s).

Parameters:

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 42

def create_data_source_and_wait_for_state(management_agent_id, create_data_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_data_source(management_agent_id, create_data_source_details, base_operation_opts)
  use_util = OCI::ManagementAgent::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::ManagementAgent::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

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

Calls OCI::ManagementAgent::ManagementAgentClient#create_management_agent_install_key and then waits for the OCI::ManagementAgent::Models::ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:

Returns:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 92

def create_management_agent_install_key_and_wait_for_state(create_management_agent_install_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_management_agent_install_key(create_management_agent_install_key_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_management_agent_install_key(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_data_source_and_wait_for_state(management_agent_id, data_source_key, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::ManagementAgent::ManagementAgentClient#delete_data_source and then waits for the OCI::ManagementAgent::Models::WorkRequest to enter the given state(s).

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • data_source_key (String) —

    Data source type and name identifier.

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

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

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

    Any optional arguments accepted by OCI::ManagementAgent::ManagementAgentClient#delete_data_source

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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 132

def delete_data_source_and_wait_for_state(management_agent_id, data_source_key, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.delete_data_source(management_agent_id, data_source_key, base_operation_opts)
  use_util = OCI::ManagementAgent::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::ManagementAgent::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

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

Calls OCI::ManagementAgent::ManagementAgentClient#delete_management_agent and then waits for the OCI::ManagementAgent::Models::ManagementAgent acted upon to enter the given state(s).

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

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

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

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

    Any optional arguments accepted by OCI::ManagementAgent::ManagementAgentClient#delete_management_agent

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



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 182

def delete_management_agent_and_wait_for_state(management_agent_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_management_agent(management_agent_id)
  operation_result = @service_client.delete_management_agent(management_agent_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

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

Calls OCI::ManagementAgent::ManagementAgentClient#delete_management_agent_install_key and then waits for the OCI::ManagementAgent::Models::ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 222

def delete_management_agent_install_key_and_wait_for_state(management_agent_install_key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_management_agent_install_key(management_agent_install_key_id)
  operation_result = @service_client.delete_management_agent_install_key(management_agent_install_key_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

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

Calls OCI::ManagementAgent::ManagementAgentClient#deploy_plugins and then waits for the OCI::ManagementAgent::Models::WorkRequest to enter the given state(s).

Parameters:

Returns:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 262

def deploy_plugins_and_wait_for_state(deploy_plugins_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.deploy_plugins(deploy_plugins_details, base_operation_opts)
  use_util = OCI::ManagementAgent::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::ManagementAgent::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_data_source_and_wait_for_state(management_agent_id, data_source_key, update_data_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::ManagementAgent::ManagementAgentClient#update_data_source and then waits for the OCI::ManagementAgent::Models::WorkRequest to enter the given state(s).

Parameters:

  • management_agent_id (String) —

    Unique Management Agent identifier

  • data_source_key (String) —

    Data source type and name identifier.

  • update_data_source_details (OCI::ManagementAgent::Models::UpdateDataSourceDetails) —

    Details of DataSource to be update for the given Management Agent.

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

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

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

    Any optional arguments accepted by OCI::ManagementAgent::ManagementAgentClient#update_data_source

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



314
315
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
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 314

def update_data_source_and_wait_for_state(management_agent_id, data_source_key, update_data_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_data_source(management_agent_id, data_source_key, update_data_source_details, base_operation_opts)
  use_util = OCI::ManagementAgent::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::ManagementAgent::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_management_agent_and_wait_for_state(management_agent_id, update_management_agent_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::ManagementAgent::ManagementAgentClient#update_management_agent and then waits for the OCI::ManagementAgent::Models::ManagementAgent acted upon to enter the given state(s).

Parameters:

Returns:



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 365

def update_management_agent_and_wait_for_state(management_agent_id, update_management_agent_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_management_agent(management_agent_id, update_management_agent_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_management_agent(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_management_agent_install_key_and_wait_for_state(management_agent_install_key_id, update_management_agent_install_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::ManagementAgent::ManagementAgentClient#update_management_agent_install_key and then waits for the OCI::ManagementAgent::Models::ManagementAgentInstallKey acted upon to enter the given state(s).

Parameters:

Returns:



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/oci/management_agent/management_agent_client_composite_operations.rb', line 405

def update_management_agent_install_key_and_wait_for_state(management_agent_install_key_id, update_management_agent_install_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_management_agent_install_key(management_agent_install_key_id, update_management_agent_install_key_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_management_agent_install_key(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