class OCI::Bastion::BastionClientCompositeOperations
This class provides a wrapper around {OCI::Bastion::BastionClient} 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::Bastion::BastionClient} used to communicate with the service_client
@return [OCI::Bastion::BastionClient]
Public Class Methods
Initializes a new BastionClientCompositeOperations
@param [OCI::Bastion::BastionClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::Bastion::BastionClient#initialize} with no arguments
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 20 def initialize(service_client = OCI::Bastion::BastionClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::Bastion::BastionClient#create_bastion} and then waits for the {OCI::Bastion::Models::WorkRequest} to enter the given state(s).
@param [OCI::Bastion::Models::CreateBastionDetails] create_bastion_details Details for the new bastion. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#create_bastion} @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::Bastion::Models::WorkRequest}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 39 def create_bastion_and_wait_for_state(create_bastion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_bastion(create_bastion_details, base_operation_opts) use_util = OCI::Bastion::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::Bastion::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::Bastion::BastionClient#create_session} and then waits for the {OCI::Bastion::Models::WorkRequest} to enter the given state(s).
@param [OCI::Bastion::Models::CreateSessionDetails] create_session_details Details for the new session. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#create_session} @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::Bastion::Models::WorkRequest}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 88 def create_session_and_wait_for_state(create_session_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_session(create_session_details, base_operation_opts) use_util = OCI::Bastion::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::Bastion::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::Bastion::BastionClient#delete_bastion} and then waits for the {OCI::Bastion::Models::WorkRequest} to enter the given state(s).
@param [String] bastion_id The unique identifier (OCID) of the bastion. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#delete_bastion} @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::Bastion::Models::WorkRequest}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 137 def delete_bastion_and_wait_for_state(bastion_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_bastion(bastion_id, base_operation_opts) use_util = OCI::Bastion::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::Bastion::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::Bastion::BastionClient#delete_session} and then waits for the {OCI::Bastion::Models::WorkRequest} to enter the given state(s).
@param [String] session_id The unique identifier (OCID) of the session. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#delete_session} @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::Bastion::Models::WorkRequest}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 186 def delete_session_and_wait_for_state(session_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_session(session_id, base_operation_opts) use_util = OCI::Bastion::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::Bastion::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::Bastion::BastionClient#update_bastion} and then waits for the {OCI::Bastion::Models::WorkRequest} to enter the given state(s).
@param [String] bastion_id The unique identifier (OCID) of the bastion. @param [OCI::Bastion::Models::UpdateBastionDetails] update_bastion_details The bastion information to be updated. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#update_bastion} @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::Bastion::Models::WorkRequest}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 236 def update_bastion_and_wait_for_state(bastion_id, update_bastion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_bastion(bastion_id, update_bastion_details, base_operation_opts) use_util = OCI::Bastion::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::Bastion::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::Bastion::BastionClient#update_session} and then waits for the {OCI::Bastion::Models::Session} acted upon to enter the given state(s).
@param [String] session_id The unique identifier (OCID) of the session. @param [OCI::Bastion::Models::UpdateSessionDetails] update_session_details The session information to be updated. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Bastion::Models::Session#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Bastion::BastionClient#update_session} @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::Bastion::Models::Session}
# File lib/oci/bastion/bastion_client_composite_operations.rb, line 286 def update_session_and_wait_for_state(session_id, update_session_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_session(session_id, update_session_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_session(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