class OCI::ApmControlPlane::ApmDomainClientCompositeOperations
This class provides a wrapper around {OCI::ApmControlPlane::ApmDomainClient} 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::ApmControlPlane::ApmDomainClient} used to communicate with the service_client
@return [OCI::ApmControlPlane::ApmDomainClient]
Public Class Methods
Initializes a new ApmDomainClientCompositeOperations
@param [OCI::ApmControlPlane::ApmDomainClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::ApmControlPlane::ApmDomainClient#initialize} with no arguments
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 20 def initialize(service_client = OCI::ApmControlPlane::ApmDomainClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::ApmControlPlane::ApmDomainClient#change_apm_domain_compartment} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [String] apm_domain_id OCID of the APM Domain @param [OCI::ApmControlPlane::Models::ChangeApmDomainCompartmentDetails] change_apm_domain_compartment_details The information to be used in changing compartment. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#change_apm_domain_compartment} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 40 def change_apm_domain_compartment_and_wait_for_state(apm_domain_id, change_apm_domain_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.change_apm_domain_compartment(apm_domain_id, change_apm_domain_compartment_details, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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::ApmControlPlane::ApmDomainClient#create_apm_domain} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [OCI::ApmControlPlane::Models::CreateApmDomainDetails] create_apm_domain_details Details for the new APM Domain. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#create_apm_domain} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 89 def create_apm_domain_and_wait_for_state(create_apm_domain_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_apm_domain(create_apm_domain_details, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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::ApmControlPlane::ApmDomainClient#delete_apm_domain} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [String] apm_domain_id OCID of the APM Domain @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#delete_apm_domain} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 138 def delete_apm_domain_and_wait_for_state(apm_domain_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_apm_domain(apm_domain_id, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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::ApmControlPlane::ApmDomainClient#generate_data_keys} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [Array<OCI::ApmControlPlane::Models::OCI::ApmControlPlane::Models::GenerateDataKeyDetails>] generate_data_keys_list_details List of new Data Keys to be generated. @param [String] apm_domain_id OCID of the APM Domain @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#generate_data_keys} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 188 def generate_data_keys_and_wait_for_state(generate_data_keys_list_details, apm_domain_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.generate_data_keys(generate_data_keys_list_details, apm_domain_id, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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::ApmControlPlane::ApmDomainClient#remove_data_keys} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [String] apm_domain_id OCID of the APM Domain @param [Array<OCI::ApmControlPlane::Models::OCI::ApmControlPlane::Models::RemoveDataKeyDetails>] remove_data_keys_list_details List of Data Keys to be removed. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#remove_data_keys} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 238 def remove_data_keys_and_wait_for_state(apm_domain_id, remove_data_keys_list_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.remove_data_keys(apm_domain_id, remove_data_keys_list_details, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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::ApmControlPlane::ApmDomainClient#update_apm_domain} and then waits for the {OCI::ApmControlPlane::Models::WorkRequest} to enter the given state(s).
@param [String] apm_domain_id OCID of the APM Domain @param [OCI::ApmControlPlane::Models::UpdateApmDomainDetails] update_apm_domain_details The information to be updated for the APM Domain. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApmControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApmControlPlane::ApmDomainClient#update_apm_domain} @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::ApmControlPlane::Models::WorkRequest}
# File lib/oci/apm_control_plane/apm_domain_client_composite_operations.rb, line 288 def update_apm_domain_and_wait_for_state(apm_domain_id, update_apm_domain_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_apm_domain(apm_domain_id, update_apm_domain_details, base_operation_opts) use_util = OCI::ApmControlPlane::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::ApmControlPlane::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