class OCI::ApplicationMigration::ApplicationMigrationClientCompositeOperations
This class provides a wrapper around {OCI::ApplicationMigration::ApplicationMigrationClient} 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::ApplicationMigration::ApplicationMigrationClient} used to communicate with the service_client
@return [OCI::ApplicationMigration::ApplicationMigrationClient]
Public Class Methods
Initializes a new ApplicationMigrationClientCompositeOperations
@param [OCI::ApplicationMigration::ApplicationMigrationClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::ApplicationMigration::ApplicationMigrationClient#initialize} with no arguments
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 20 def initialize(service_client = OCI::ApplicationMigration::ApplicationMigrationClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::ApplicationMigration::ApplicationMigrationClient#change_migration_compartment} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] migration_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the migration. @param [OCI::ApplicationMigration::Models::ChangeCompartmentDetails] change_migration_compartment_details The updated compartment details @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#change_migration_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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 40 def change_migration_compartment_and_wait_for_state(migration_id, change_migration_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.change_migration_compartment(migration_id, change_migration_compartment_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#change_source_compartment} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] source_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source. @param [OCI::ApplicationMigration::Models::ChangeCompartmentDetails] change_source_compartment_details The updated compartment details @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#change_source_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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 90 def change_source_compartment_and_wait_for_state(source_id, change_source_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.change_source_compartment(source_id, change_source_compartment_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#create_migration} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [OCI::ApplicationMigration::Models::CreateMigrationDetails] create_migration_details The properties for creating a migration. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#create_migration} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 139 def create_migration_and_wait_for_state(create_migration_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_migration(create_migration_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#create_source} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [OCI::ApplicationMigration::Models::CreateSourceDetails] create_source_details The properties for creating a source. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#create_source} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 188 def create_source_and_wait_for_state(create_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_source(create_source_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#delete_migration} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] migration_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the migration. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#delete_migration} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 237 def delete_migration_and_wait_for_state(migration_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_migration(migration_id, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#delete_source} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] source_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#delete_source} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 286 def delete_source_and_wait_for_state(source_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_source(source_id, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#migrate_application} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] migration_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the migration. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#migrate_application} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 335 def migrate_application_and_wait_for_state(migration_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.migrate_application(migration_id, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#update_migration} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] migration_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the migration. @param [OCI::ApplicationMigration::Models::UpdateMigrationDetails] update_migration_details Updated configuration for the migration.
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#update_migration} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 386 def update_migration_and_wait_for_state(migration_id, update_migration_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_migration(migration_id, update_migration_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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::ApplicationMigration::ApplicationMigrationClient#update_source} and then waits for the {OCI::ApplicationMigration::Models::WorkRequest} to enter the given state(s).
@param [String] source_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the source. @param [OCI::ApplicationMigration::Models::UpdateSourceDetails] update_source_details Updated configuration for the source.
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ApplicationMigration::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ApplicationMigration::ApplicationMigrationClient#update_source} @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::ApplicationMigration::Models::WorkRequest}
# File lib/oci/application_migration/application_migration_client_composite_operations.rb, line 437 def update_source_and_wait_for_state(source_id, update_source_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_source(source_id, update_source_details, base_operation_opts) use_util = OCI::ApplicationMigration::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::ApplicationMigration::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