class OCI::Artifacts::ArtifactsClientCompositeOperations
This class provides a wrapper around {OCI::Artifacts::ArtifactsClient} 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::Artifacts::ArtifactsClient} used to communicate with the service_client
@return [OCI::Artifacts::ArtifactsClient]
Public Class Methods
Initializes a new ArtifactsClientCompositeOperations
@param [OCI::Artifacts::ArtifactsClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::Artifacts::ArtifactsClient#initialize} with no arguments
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 20 def initialize(service_client = OCI::Artifacts::ArtifactsClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::Artifacts::ArtifactsClient#create_container_repository} and then waits for the {OCI::Artifacts::Models::ContainerRepository} acted upon to enter the given state(s).
@param [OCI::Artifacts::Models::CreateContainerRepositoryDetails] create_container_repository_details Create container repository details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerRepository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#create_container_repository} @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::Artifacts::Models::ContainerRepository}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 39 def create_container_repository_and_wait_for_state(create_container_repository_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_container_repository(create_container_repository_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_container_repository(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::Artifacts::ArtifactsClient#create_repository} and then waits for the {OCI::Artifacts::Models::Repository} acted upon to enter the given state(s).
@param [OCI::Artifacts::Models::CreateRepositoryDetails] create_repository_details Creates a new repository for storing artifacts. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::Repository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#create_repository} @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::Artifacts::Models::Repository}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 78 def create_repository_and_wait_for_state(create_repository_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_repository(create_repository_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_repository(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::Artifacts::ArtifactsClient#delete_container_image} and then waits for the {OCI::Artifacts::Models::ContainerImage} acted upon to enter the given state(s).
@param [String] image_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerImage#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#delete_container_image} @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/artifacts/artifacts_client_composite_operations.rb, line 120 def delete_container_image_and_wait_for_state(image_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) initial_get_result = @service_client.get_container_image(image_id) operation_result = @service_client.delete_container_image(image_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::Artifacts::ArtifactsClient#delete_container_repository} and then waits for the {OCI::Artifacts::Models::ContainerRepository} acted upon to enter the given state(s).
@param [String] repository_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerRepository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#delete_container_repository} @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/artifacts/artifacts_client_composite_operations.rb, line 163 def delete_container_repository_and_wait_for_state(repository_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) initial_get_result = @service_client.get_container_repository(repository_id) operation_result = @service_client.delete_container_repository(repository_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::Artifacts::ArtifactsClient#delete_generic_artifact} and then waits for the {OCI::Artifacts::Models::GenericArtifact} acted upon to enter the given state(s).
@param [String] artifact_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.
Example: `ocid1.genericartifact.oc1..exampleuniqueID`
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::GenericArtifact#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#delete_generic_artifact} @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/artifacts/artifacts_client_composite_operations.rb, line 206 def delete_generic_artifact_and_wait_for_state(artifact_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) initial_get_result = @service_client.get_generic_artifact(artifact_id) operation_result = @service_client.delete_generic_artifact(artifact_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::Artifacts::ArtifactsClient#delete_repository} and then waits for the {OCI::Artifacts::Models::Repository} acted upon to enter the given state(s).
@param [String] repository_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.
Example: `ocid1.artifactrepository.oc1..exampleuniqueID`
@param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::Repository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#delete_repository} @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/artifacts/artifacts_client_composite_operations.rb, line 249 def delete_repository_and_wait_for_state(repository_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) initial_get_result = @service_client.get_repository(repository_id) operation_result = @service_client.delete_repository(repository_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::Artifacts::ArtifactsClient#remove_container_version} and then waits for the {OCI::Artifacts::Models::ContainerImage} acted upon to enter the given state(s).
@param [String] image_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`
@param [OCI::Artifacts::Models::RemoveContainerVersionDetails] remove_container_version_details Remove version details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerImage#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#remove_container_version} @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::Artifacts::Models::ContainerImage}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 293 def remove_container_version_and_wait_for_state(image_id, remove_container_version_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.remove_container_version(image_id, remove_container_version_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_container_image(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::Artifacts::ArtifactsClient#restore_container_image} and then waits for the {OCI::Artifacts::Models::ContainerImage} acted upon to enter the given state(s).
@param [String] image_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.
Example: `ocid1.containerimage.oc1..exampleuniqueID`
@param [OCI::Artifacts::Models::RestoreContainerImageDetails] restore_container_image_details Restore container image details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerImage#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#restore_container_image} @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::Artifacts::Models::ContainerImage}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 336 def restore_container_image_and_wait_for_state(image_id, restore_container_image_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.restore_container_image(image_id, restore_container_image_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_container_image(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::Artifacts::ArtifactsClient#update_container_repository} and then waits for the {OCI::Artifacts::Models::ContainerRepository} acted upon to enter the given state(s).
@param [String] repository_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.
Example: `ocid1.containerrepo.oc1..exampleuniqueID`
@param [OCI::Artifacts::Models::UpdateContainerRepositoryDetails] update_container_repository_details Update container repository details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::ContainerRepository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#update_container_repository} @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::Artifacts::Models::ContainerRepository}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 379 def update_container_repository_and_wait_for_state(repository_id, update_container_repository_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_container_repository(repository_id, update_container_repository_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_container_repository(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::Artifacts::ArtifactsClient#update_generic_artifact} and then waits for the {OCI::Artifacts::Models::GenericArtifact} acted upon to enter the given state(s).
@param [String] artifact_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.
Example: `ocid1.genericartifact.oc1..exampleuniqueID`
@param [OCI::Artifacts::Models::UpdateGenericArtifactDetails] update_generic_artifact_details Updates the artifact with the specified [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can only update the tags of an artifact. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::GenericArtifact#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#update_generic_artifact} @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::Artifacts::Models::GenericArtifact}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 422 def update_generic_artifact_and_wait_for_state(artifact_id, update_generic_artifact_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_generic_artifact(artifact_id, update_generic_artifact_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_generic_artifact(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::Artifacts::ArtifactsClient#update_repository} and then waits for the {OCI::Artifacts::Models::Repository} acted upon to enter the given state(s).
@param [String] repository_id The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.
Example: `ocid1.artifactrepository.oc1..exampleuniqueID`
@param [OCI::Artifacts::Models::UpdateRepositoryDetails] update_repository_details Updates the properties of a repository. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Artifacts::Models::Repository#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Artifacts::ArtifactsClient#update_repository} @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::Artifacts::Models::Repository}
# File lib/oci/artifacts/artifacts_client_composite_operations.rb, line 465 def update_repository_and_wait_for_state(repository_id, update_repository_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_repository(repository_id, update_repository_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_repository(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