class OCI::Optimizer::OptimizerClientCompositeOperations
This class provides a wrapper around {OCI::Optimizer::OptimizerClient} 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
Attributes
The {OCI::Optimizer::OptimizerClient} used to communicate with the service_client
@return [OCI::Optimizer::OptimizerClient]
Public Class Methods
Initializes a new OptimizerClientCompositeOperations
@param [OCI::Optimizer::OptimizerClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::Optimizer::OptimizerClient#initialize} with no arguments
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 20 def initialize(service_client = OCI::Optimizer::OptimizerClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::Optimizer::OptimizerClient#bulk_apply_recommendations} and then waits for the {OCI::Optimizer::Models::WorkRequest} to enter the given state(s).
@param [String] recommendation_id The unique OCID associated with the recommendation. @param [OCI::Optimizer::Models::BulkApplyRecommendationsDetails] bulk_apply_recommendations_details Details about bulk recommendation actions. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#bulk_apply_recommendations} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object containing the completed {OCI::Optimizer::Models::WorkRequest}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 40 def bulk_apply_recommendations_and_wait_for_state(recommendation_id, bulk_apply_recommendations_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.bulk_apply_recommendations(recommendation_id, bulk_apply_recommendations_details, base_operation_opts) use_util = OCI::Optimizer::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::Optimizer::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
Calls {OCI::Optimizer::OptimizerClient#create_profile} and then waits for the {OCI::Optimizer::Models::Profile} acted upon to enter the given state(s).
@param [OCI::Optimizer::Models::CreateProfileDetails] create_profile_details Details for creating the profile. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::Profile#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#create_profile} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type {OCI::Optimizer::Models::Profile}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 89 def create_profile_and_wait_for_state(create_profile_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_profile(create_profile_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_profile(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
Calls {OCI::Optimizer::OptimizerClient#delete_profile} and then waits for the {OCI::Optimizer::Models::Profile} acted upon to enter the given state(s).
@param [String] profile_id The unique OCID of the profile. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::Profile#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#delete_profile} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type nil
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 128 def delete_profile_and_wait_for_state(profile_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) initial_get_result = @service_client.get_profile(profile_id) operation_result = @service_client.delete_profile(profile_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
Calls {OCI::Optimizer::OptimizerClient#update_enrollment_status} and then waits for the {OCI::Optimizer::Models::EnrollmentStatus} acted upon to enter the given state(s).
@param [String] enrollment_status_id The unique OCID associated with the enrollment status. @param [OCI::Optimizer::Models::UpdateEnrollmentStatusDetails] update_enrollment_status_details The request object for updating the enrollment status. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::EnrollmentStatus#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#update_enrollment_status} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type {OCI::Optimizer::Models::EnrollmentStatus}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 169 def update_enrollment_status_and_wait_for_state(enrollment_status_id, update_enrollment_status_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_enrollment_status(enrollment_status_id, update_enrollment_status_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_enrollment_status(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
Calls {OCI::Optimizer::OptimizerClient#update_profile} and then waits for the {OCI::Optimizer::Models::Profile} acted upon to enter the given state(s).
@param [String] profile_id The unique OCID of the profile. @param [OCI::Optimizer::Models::UpdateProfileDetails] update_profile_details The profile information to use for the update. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::Profile#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#update_profile} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type {OCI::Optimizer::Models::Profile}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 209 def update_profile_and_wait_for_state(profile_id, update_profile_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_profile(profile_id, update_profile_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_profile(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
Calls {OCI::Optimizer::OptimizerClient#update_recommendation} and then waits for the {OCI::Optimizer::Models::Recommendation} acted upon to enter the given state(s).
@param [String] recommendation_id The unique OCID associated with the recommendation. @param [OCI::Optimizer::Models::UpdateRecommendationDetails] update_recommendation_details The request object for udpating the recommendation details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::Recommendation#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#update_recommendation} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type {OCI::Optimizer::Models::Recommendation}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 249 def update_recommendation_and_wait_for_state(recommendation_id, update_recommendation_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_recommendation(recommendation_id, update_recommendation_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_recommendation(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
Calls {OCI::Optimizer::OptimizerClient#update_resource_action} and then waits for the {OCI::Optimizer::Models::ResourceAction} acted upon to enter the given state(s).
@param [String] resource_action_id The unique OCID associated with the resource action. @param [OCI::Optimizer::Models::UpdateResourceActionDetails] update_resource_action_details The resource action information to be updated. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Optimizer::Models::ResourceAction#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Optimizer::OptimizerClient#update_resource_action} @param [Hash] waiter_opts 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
@return [OCI::Response] A {OCI::Response} object with data of type {OCI::Optimizer::Models::ResourceAction}
# File lib/oci/optimizer/optimizer_client_composite_operations.rb, line 289 def update_resource_action_and_wait_for_state(resource_action_id, update_resource_action_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_resource_action(resource_action_id, update_resource_action_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_resource_action(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