Class: OCI::KeyManagement::KmsHsmClusterClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb

Overview

This class provides a wrapper around KmsHsmClusterClient 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

Instance Method Summary collapse

Constructor Details

#initialize(service_client = OCI::KeyManagement::KmsHsmClusterClient.new) ⇒ KmsHsmClusterClientCompositeOperations

Initializes a new KmsHsmClusterClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 22

def initialize(service_client = OCI::KeyManagement::KmsHsmClusterClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::KeyManagement::KmsHsmClusterClient (readonly)

The OCI::KeyManagement::KmsHsmClusterClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#cancel_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::KeyManagement::KmsHsmClusterClient#cancel_hsm_cluster_deletion and then waits for the Models::HsmCluster acted upon to enter the given state(s).

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster.

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::HsmCluster#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::KeyManagement::KmsHsmClusterClient#cancel_hsm_cluster_deletion

  • waiter_opts (Hash) (defaults to: {}) —

    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

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 41

def cancel_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.cancel_hsm_cluster_deletion(hsm_cluster_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_hsm_cluster(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_hsm_cluster_and_wait_for_state(create_hsm_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::KeyManagement::KmsHsmClusterClient#create_hsm_cluster and then waits for the Models::HsmCluster acted upon to enter the given state(s).

Parameters:

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 80

def create_hsm_cluster_and_wait_for_state(create_hsm_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_hsm_cluster(create_hsm_cluster_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_hsm_cluster(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_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, schedule_hsm_cluster_deletion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::KeyManagement::KmsHsmClusterClient#schedule_hsm_cluster_deletion and then waits for the Models::HsmCluster acted upon to enter the given state(s).

Parameters:

Returns:



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 120

def schedule_hsm_cluster_deletion_and_wait_for_state(hsm_cluster_id, schedule_hsm_cluster_deletion_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.schedule_hsm_cluster_deletion(hsm_cluster_id, schedule_hsm_cluster_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_hsm_cluster(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_hsm_cluster_and_wait_for_state(hsm_cluster_id, update_hsm_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::KeyManagement::KmsHsmClusterClient#update_hsm_cluster and then waits for the Models::HsmCluster acted upon to enter the given state(s).

Parameters:

  • hsm_cluster_id (String) —

    The OCID of the HSM Cluster.

  • update_hsm_cluster_details (OCI::KeyManagement::Models::UpdateHsmClusterDetails) —

    Details of the HsmCluster Resource

  • wait_for_states (Array<String>) (defaults to: []) —

    An array of states to wait on. These should be valid values for Models::HsmCluster#lifecycle_state

  • base_operation_opts (Hash) (defaults to: {}) —

    Any optional arguments accepted by OCI::KeyManagement::KmsHsmClusterClient#update_hsm_cluster

  • waiter_opts (Hash) (defaults to: {}) —

    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

Returns:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/key_management/kms_hsm_cluster_client_composite_operations.rb', line 160

def update_hsm_cluster_and_wait_for_state(hsm_cluster_id, update_hsm_cluster_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_hsm_cluster(hsm_cluster_id, update_hsm_cluster_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_hsm_cluster(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