Class: OCI::Opensearch::OpensearchClusterBackupClientCompositeOperations
- Inherits:
-
Object
- Object
- OCI::Opensearch::OpensearchClusterBackupClientCompositeOperations
- Defined in:
- lib/oci/opensearch/opensearch_cluster_backup_client_composite_operations.rb
Overview
This class provides a wrapper around OpensearchClusterBackupClient 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
Instance Attribute Summary collapse
-
#service_client ⇒ OCI::Opensearch::OpensearchClusterBackupClient
readonly
The OpensearchClusterBackupClient used to communicate with the service_client.
Instance Method Summary collapse
-
#delete_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::Opensearch::OpensearchClusterBackupClient#delete_opensearch_cluster_backup and then waits for the Models::WorkRequest to enter the given state(s).
-
#initialize(service_client = OCI::Opensearch::OpensearchClusterBackupClient.new) ⇒ OpensearchClusterBackupClientCompositeOperations
constructor
Initializes a new OpensearchClusterBackupClientCompositeOperations.
-
#update_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::Opensearch::OpensearchClusterBackupClient#update_opensearch_cluster_backup and then waits for the Models::WorkRequest to enter the given state(s).
Constructor Details
#initialize(service_client = OCI::Opensearch::OpensearchClusterBackupClient.new) ⇒ OpensearchClusterBackupClientCompositeOperations
Initializes a new OpensearchClusterBackupClientCompositeOperations
22 23 24 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client_composite_operations.rb', line 22 def initialize(service_client = OCI::Opensearch::OpensearchClusterBackupClient.new) @service_client = service_client end |
Instance Attribute Details
#service_client ⇒ OCI::Opensearch::OpensearchClusterBackupClient (readonly)
The OCI::Opensearch::OpensearchClusterBackupClient used to communicate with the service_client
16 17 18 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client_composite_operations.rb', line 16 def service_client @service_client end |
Instance Method Details
#delete_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::Opensearch::OpensearchClusterBackupClient#delete_opensearch_cluster_backup and then waits for the Models::WorkRequest to enter the given state(s).
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client_composite_operations.rb', line 41 def delete_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.delete_opensearch_cluster_backup(opensearch_cluster_backup_id, base_operation_opts) use_util = OCI::Opensearch::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'] return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty? begin if use_util waiter_result = OCI::Opensearch::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 |
#update_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::Opensearch::OpensearchClusterBackupClient#update_opensearch_cluster_backup and then waits for the Models::WorkRequest to enter the given state(s).
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 |
# File 'lib/oci/opensearch/opensearch_cluster_backup_client_composite_operations.rb', line 92 def update_opensearch_cluster_backup_and_wait_for_state(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_opensearch_cluster_backup(opensearch_cluster_backup_id, update_opensearch_cluster_backup_details, base_operation_opts) use_util = OCI::Opensearch::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'] return operation_result if wait_for_resource_id.nil? || wait_for_resource_id.empty? begin if use_util waiter_result = OCI::Opensearch::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 |