class OCI::TenantManagerControlPlane::SenderInvitationClientCompositeOperations
This class provides a wrapper around {OCI::TenantManagerControlPlane::SenderInvitationClient} 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::TenantManagerControlPlane::SenderInvitationClient} used to communicate with the service_client
@return [OCI::TenantManagerControlPlane::SenderInvitationClient]
Public Class Methods
Initializes a new SenderInvitationClientCompositeOperations
@param [OCI::TenantManagerControlPlane::SenderInvitationClient] service_client
The client used to communicate with the service.
Defaults to a new service client created via {OCI::TenantManagerControlPlane::SenderInvitationClient#initialize} with no arguments
# File lib/oci/tenant_manager_control_plane/sender_invitation_client_composite_operations.rb, line 20 def initialize(service_client = OCI::TenantManagerControlPlane::SenderInvitationClient.new) @service_client = service_client end
Public Instance Methods
Calls {OCI::TenantManagerControlPlane::SenderInvitationClient#cancel_sender_invitation} and then waits for the {OCI::TenantManagerControlPlane::Models::WorkRequest} to enter the given state(s).
@param [String] sender_invitation_id OCID of the sender invitation to cancel. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::TenantManagerControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::TenantManagerControlPlane::SenderInvitationClient#cancel_sender_invitation} @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 containing the completed {OCI::TenantManagerControlPlane::Models::WorkRequest}
# File lib/oci/tenant_manager_control_plane/sender_invitation_client_composite_operations.rb, line 39 def cancel_sender_invitation_and_wait_for_state(sender_invitation_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.cancel_sender_invitation(sender_invitation_id, base_operation_opts) use_util = OCI::TenantManagerControlPlane::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'] begin if use_util waiter_result = OCI::TenantManagerControlPlane::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
Calls {OCI::TenantManagerControlPlane::SenderInvitationClient#create_sender_invitation} and then waits for the {OCI::TenantManagerControlPlane::Models::WorkRequest} to enter the given state(s).
@param [OCI::TenantManagerControlPlane::Models::CreateSenderInvitationDetails] create_sender_invitation_details Parameters for sender invitation creation. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::TenantManagerControlPlane::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::TenantManagerControlPlane::SenderInvitationClient#create_sender_invitation} @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 containing the completed {OCI::TenantManagerControlPlane::Models::WorkRequest}
# File lib/oci/tenant_manager_control_plane/sender_invitation_client_composite_operations.rb, line 88 def create_sender_invitation_and_wait_for_state(create_sender_invitation_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.create_sender_invitation(create_sender_invitation_details, base_operation_opts) use_util = OCI::TenantManagerControlPlane::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'] begin if use_util waiter_result = OCI::TenantManagerControlPlane::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
Calls {OCI::TenantManagerControlPlane::SenderInvitationClient#update_sender_invitation} and then waits for the {OCI::TenantManagerControlPlane::Models::SenderInvitation} acted upon to enter the given state(s).
@param [String] sender_invitation_id OCID of the sender invitation to update. @param [OCI::TenantManagerControlPlane::Models::UpdateSenderInvitationDetails] update_sender_invitation_details The information to be updated. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::TenantManagerControlPlane::Models::SenderInvitation#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::TenantManagerControlPlane::SenderInvitationClient#update_sender_invitation} @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::TenantManagerControlPlane::Models::SenderInvitation}
# File lib/oci/tenant_manager_control_plane/sender_invitation_client_composite_operations.rb, line 138 def update_sender_invitation_and_wait_for_state(sender_invitation_id, update_sender_invitation_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) operation_result = @service_client.update_sender_invitation(sender_invitation_id, update_sender_invitation_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_sender_invitation(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