class OCI::ServiceCatalog::ServiceCatalogClientCompositeOperations

This class provides a wrapper around {OCI::ServiceCatalog::ServiceCatalogClient} 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

service_client[R]

The {OCI::ServiceCatalog::ServiceCatalogClient} used to communicate with the service_client

@return [OCI::ServiceCatalog::ServiceCatalogClient]

Public Class Methods

new(service_client = OCI::ServiceCatalog::ServiceCatalogClient.new) click to toggle source

Initializes a new ServiceCatalogClientCompositeOperations

@param [OCI::ServiceCatalog::ServiceCatalogClient] service_client The client used to communicate with the service.

Defaults to a new service client created via {OCI::ServiceCatalog::ServiceCatalogClient#initialize} with no arguments
# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 20
def initialize(service_client = OCI::ServiceCatalog::ServiceCatalogClient.new)
  @service_client = service_client
end

Public Instance Methods

change_private_application_compartment_and_wait_for_state(private_application_id, change_private_application_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#change_private_application_compartment} and then waits for the {OCI::ServiceCatalog::Models::WorkRequest} to enter the given state(s).

@param [String] private_application_id The unique identifier for the private application. @param [OCI::ServiceCatalog::Models::ChangePrivateApplicationCompartmentDetails] change_private_application_compartment_details The details of the request to change the compartment of a given private application. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#change_private_application_compartment} @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::ServiceCatalog::Models::WorkRequest}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 40
def change_private_application_compartment_and_wait_for_state(private_application_id, change_private_application_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.change_private_application_compartment(private_application_id, change_private_application_compartment_details, base_operation_opts)
  use_util = OCI::ServiceCatalog::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::ServiceCatalog::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
create_private_application_and_wait_for_state(create_private_application_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#create_private_application} and then waits for the {OCI::ServiceCatalog::Models::WorkRequest} to enter the given state(s).

@param [OCI::ServiceCatalog::Models::CreatePrivateApplicationDetails] create_private_application_details Private application creation details. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#create_private_application} @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::ServiceCatalog::Models::WorkRequest}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 89
def create_private_application_and_wait_for_state(create_private_application_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_private_application(create_private_application_details, base_operation_opts)
  use_util = OCI::ServiceCatalog::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::ServiceCatalog::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
create_service_catalog_and_wait_for_state(create_service_catalog_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#create_service_catalog} and then waits for the {OCI::ServiceCatalog::Models::ServiceCatalog} acted upon to enter the given state(s).

@param [OCI::ServiceCatalog::Models::CreateServiceCatalogDetails] create_service_catalog_details The details for creating a service catalog. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::ServiceCatalog#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#create_service_catalog} @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::ServiceCatalog::Models::ServiceCatalog}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 138
def create_service_catalog_and_wait_for_state(create_service_catalog_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_service_catalog(create_service_catalog_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_service_catalog(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_private_application_and_wait_for_state(private_application_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#delete_private_application} and then waits for the {OCI::ServiceCatalog::Models::WorkRequest} to enter the given state(s).

@param [String] private_application_id The unique identifier for the private application. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#delete_private_application} @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::ServiceCatalog::Models::WorkRequest}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 177
def delete_private_application_and_wait_for_state(private_application_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.delete_private_application(private_application_id, base_operation_opts)
  use_util = OCI::ServiceCatalog::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::ServiceCatalog::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
delete_service_catalog_and_wait_for_state(service_catalog_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#delete_service_catalog} and then waits for the {OCI::ServiceCatalog::Models::ServiceCatalog} acted upon to enter the given state(s).

@param [String] service_catalog_id The unique identifier for the service catalog. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::ServiceCatalog#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#delete_service_catalog} @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 nil

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 226
def delete_service_catalog_and_wait_for_state(service_catalog_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  initial_get_result = @service_client.get_service_catalog(service_catalog_id)
  operation_result = @service_client.delete_service_catalog(service_catalog_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_private_application_and_wait_for_state(private_application_id, update_private_application_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#update_private_application} and then waits for the {OCI::ServiceCatalog::Models::WorkRequest} to enter the given state(s).

@param [String] private_application_id The unique identifier for the private application. @param [OCI::ServiceCatalog::Models::UpdatePrivateApplicationDetails] update_private_application_details The details for updating the private application. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#update_private_application} @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::ServiceCatalog::Models::WorkRequest}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 267
def update_private_application_and_wait_for_state(private_application_id, update_private_application_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_private_application(private_application_id, update_private_application_details, base_operation_opts)
  use_util = OCI::ServiceCatalog::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::ServiceCatalog::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_service_catalog_and_wait_for_state(service_catalog_id, update_service_catalog_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::ServiceCatalog::ServiceCatalogClient#update_service_catalog} and then waits for the {OCI::ServiceCatalog::Models::ServiceCatalog} acted upon to enter the given state(s).

@param [String] service_catalog_id The unique identifier for the service catalog. @param [OCI::ServiceCatalog::Models::UpdateServiceCatalogDetails] update_service_catalog_details Details to update for a service catalog. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::ServiceCatalog::Models::ServiceCatalog#lifecycle_state} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::ServiceCatalog::ServiceCatalogClient#update_service_catalog} @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::ServiceCatalog::Models::ServiceCatalog}

# File lib/oci/service_catalog/service_catalog_client_composite_operations.rb, line 317
def update_service_catalog_and_wait_for_state(service_catalog_id, update_service_catalog_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_service_catalog(service_catalog_id, update_service_catalog_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_service_catalog(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