Class: OCI::UsageApi::UsageapiClientCompositeOperations

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/usage_api/usageapi_client_composite_operations.rb

Overview

This class provides a wrapper around UsageapiClient 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::UsageApi::UsageapiClient.new) ⇒ UsageapiClientCompositeOperations

Initializes a new UsageapiClientCompositeOperations

Parameters:



22
23
24
 
# File 'lib/oci/usage_api/usageapi_client_composite_operations.rb', line 22

def initialize(service_client = OCI::UsageApi::UsageapiClient.new)
  @service_client = service_client
end

Instance Attribute Details

#service_client ⇒ OCI::UsageApi::UsageapiClient (readonly)

The OCI::UsageApi::UsageapiClient used to communicate with the service_client

Returns:



16
17
18
 
# File 'lib/oci/usage_api/usageapi_client_composite_operations.rb', line 16

def service_client
  @service_client
end

Instance Method Details

#create_email_recipients_group_and_wait_for_state(create_email_recipients_group_details, subscription_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::UsageApi::UsageapiClient#create_email_recipients_group and then waits for the Models::EmailRecipientsGroup acted upon to enter the given state(s).

Parameters:

Returns:



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

def create_email_recipients_group_and_wait_for_state(create_email_recipients_group_details, subscription_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_email_recipients_group(create_email_recipients_group_details, subscription_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_email_recipients_group(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_schedule_and_wait_for_state(create_schedule_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::UsageApi::UsageapiClient#create_schedule and then waits for the Models::Schedule acted upon to enter the given state(s).

Parameters:

  • create_schedule_details (OCI::UsageApi::Models::CreateScheduleDetails) —

    New schedule details.

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

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

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

    Any optional arguments accepted by OCI::UsageApi::UsageapiClient#create_schedule

  • 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:



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

def create_schedule_and_wait_for_state(create_schedule_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_schedule(create_schedule_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_schedule(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

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

Calls OCI::UsageApi::UsageapiClient#delete_schedule and then waits for the Models::Schedule acted upon to enter the given state(s).

Parameters:

  • schedule_id (String) —

    The schedule unique OCID.

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

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

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

    Any optional arguments accepted by OCI::UsageApi::UsageapiClient#delete_schedule

  • 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:



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

def delete_schedule_and_wait_for_state(schedule_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_schedule(schedule_id)
  operation_result = @service_client.delete_schedule(schedule_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

#update_email_recipients_group_and_wait_for_state(update_email_recipients_group_details, email_recipients_group_id, subscription_id, compartment_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::UsageApi::UsageapiClient#update_email_recipients_group and then waits for the Models::EmailRecipientsGroup acted upon to enter the given state(s).

Parameters:

  • update_email_recipients_group_details (OCI::UsageApi::Models::UpdateEmailRecipientsGroupDetails) —

    The information to be updated.

  • email_recipients_group_id (String) —

    The email recipient group OCID.

  • subscription_id (String) —

    The UsageStatement Subscription unique OCID.

  • compartment_id (String) —

    The compartment ID in which to list resources.

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

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

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

    Any optional arguments accepted by OCI::UsageApi::UsageapiClient#update_email_recipients_group

  • 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:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/usage_api/usageapi_client_composite_operations.rb', line 163

def update_email_recipients_group_and_wait_for_state(update_email_recipients_group_details, email_recipients_group_id, subscription_id, compartment_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_email_recipients_group(update_email_recipients_group_details, email_recipients_group_id, subscription_id, compartment_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_email_recipients_group(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_schedule_and_wait_for_state(update_schedule_details, schedule_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) ⇒ OCI::Response

Calls OCI::UsageApi::UsageapiClient#update_schedule and then waits for the Models::Schedule acted upon to enter the given state(s).

Parameters:

  • update_schedule_details (OCI::UsageApi::Models::UpdateScheduleDetails) —

    The information to be updated. Currently supports only tags

  • schedule_id (String) —

    The schedule unique OCID.

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

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

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

    Any optional arguments accepted by OCI::UsageApi::UsageapiClient#update_schedule

  • 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:



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/usage_api/usageapi_client_composite_operations.rb', line 203

def update_schedule_and_wait_for_state(update_schedule_details, schedule_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_schedule(update_schedule_details, schedule_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_schedule(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