Class: OCI::KeyManagement::KmsManagementClientCompositeOperations
- Inherits:
-
Object
- Object
- OCI::KeyManagement::KmsManagementClientCompositeOperations
- Defined in:
- lib/oci/key_management/kms_management_client_composite_operations.rb
Overview
This class provides a wrapper around KmsManagementClient 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::KeyManagement::KmsManagementClient
readonly
The KmsManagementClient used to communicate with the service_client.
Instance Method Summary collapse
-
#cancel_key_deletion_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#cancel_key_deletion and then waits for the Models::Key acted upon to enter the given state(s).
-
#create_key_and_wait_for_state(create_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#create_key and then waits for the Models::Key acted upon to enter the given state(s).
-
#disable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#disable_key and then waits for the Models::Key acted upon to enter the given state(s).
-
#enable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#enable_key and then waits for the Models::Key acted upon to enter the given state(s).
-
#initialize(service_client = OCI::KeyManagement::KmsManagementClient.new) ⇒ KmsManagementClientCompositeOperations
constructor
Initializes a new KmsManagementClientCompositeOperations.
-
#schedule_key_deletion_and_wait_for_state(key_id, schedule_key_deletion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#schedule_key_deletion and then waits for the Models::Key acted upon to enter the given state(s).
-
#update_key_and_wait_for_state(key_id, update_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#update_key and then waits for the Models::Key acted upon to enter the given state(s).
Constructor Details
#initialize(service_client = OCI::KeyManagement::KmsManagementClient.new) ⇒ KmsManagementClientCompositeOperations
Initializes a new KmsManagementClientCompositeOperations
19 20 21 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 19 def initialize(service_client = OCI::KeyManagement::KmsManagementClient.new) @service_client = service_client end |
Instance Attribute Details
#service_client ⇒ OCI::KeyManagement::KmsManagementClient (readonly)
The OCI::KeyManagement::KmsManagementClient used to communicate with the service_client
13 14 15 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 13 def service_client @service_client end |
Instance Method Details
#cancel_key_deletion_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#cancel_key_deletion and then waits for the Models::Key acted upon to enter the given state(s).
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 38 def cancel_key_deletion_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.cancel_key_deletion(key_id, 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_key(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 |
#create_key_and_wait_for_state(create_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#create_key and then waits for the Models::Key acted upon to enter the given state(s).
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 77 def create_key_and_wait_for_state(create_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_key(create_key_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_key(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 |
#disable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#disable_key and then waits for the Models::Key acted upon to enter the given state(s).
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 116 def disable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.disable_key(key_id, 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_key(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 |
#enable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#enable_key and then waits for the Models::Key acted upon to enter the given state(s).
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 155 def enable_key_and_wait_for_state(key_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.enable_key(key_id, 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_key(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 |
#schedule_key_deletion_and_wait_for_state(key_id, schedule_key_deletion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#schedule_key_deletion and then waits for the Models::Key acted upon to enter the given state(s).
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 195 def schedule_key_deletion_and_wait_for_state(key_id, schedule_key_deletion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.schedule_key_deletion(key_id, schedule_key_deletion_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_key(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 |
#update_key_and_wait_for_state(key_id, update_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response
Calls OCI::KeyManagement::KmsManagementClient#update_key and then waits for the Models::Key acted upon to enter the given state(s).
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/key_management/kms_management_client_composite_operations.rb', line 235 def update_key_and_wait_for_state(key_id, update_key_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_key(key_id, update_key_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_key(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 |