class OCI::Nosql::NosqlClientCompositeOperations

This class provides a wrapper around {OCI::Nosql::NosqlClient} 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::Nosql::NosqlClient} used to communicate with the service_client

@return [OCI::Nosql::NosqlClient]

Public Class Methods

new(service_client = OCI::Nosql::NosqlClient.new) click to toggle source

Initializes a new NosqlClientCompositeOperations

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

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

Public Instance Methods

change_table_compartment_and_wait_for_state(table_name_or_id, change_table_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#change_table_compartment} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] table_name_or_id A table name within the compartment, or a table OCID. @param [OCI::Nosql::Models::ChangeTableCompartmentDetails] change_table_compartment_details Specifications of the source and target compartments. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#change_table_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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 40
def change_table_compartment_and_wait_for_state(table_name_or_id, change_table_compartment_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.change_table_compartment(table_name_or_id, change_table_compartment_details, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_index_and_wait_for_state(table_name_or_id, create_index_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#create_index} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] table_name_or_id A table name within the compartment, or a table OCID. @param [OCI::Nosql::Models::CreateIndexDetails] create_index_details Specifications for the new index. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#create_index} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 90
def create_index_and_wait_for_state(table_name_or_id, create_index_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_index(table_name_or_id, create_index_details, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_table_and_wait_for_state(create_table_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#create_table} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [OCI::Nosql::Models::CreateTableDetails] create_table_details Specifications for the new table. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#create_table} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 139
def create_table_and_wait_for_state(create_table_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.create_table(create_table_details, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_index_and_wait_for_state(table_name_or_id, index_name, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#delete_index} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] table_name_or_id A table name within the compartment, or a table OCID. @param [String] index_name The name of a table's index. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#delete_index} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 189
def delete_index_and_wait_for_state(table_name_or_id, index_name, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.delete_index(table_name_or_id, index_name, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_table_and_wait_for_state(table_name_or_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#delete_table} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] table_name_or_id A table name within the compartment, or a table OCID. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#delete_table} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 238
def delete_table_and_wait_for_state(table_name_or_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.delete_table(table_name_or_id, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_work_request_and_wait_for_state(work_request_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#delete_work_request} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] work_request_id The ID of the asynchronous request. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#delete_work_request} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 287
def delete_work_request_and_wait_for_state(work_request_id, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.delete_work_request(work_request_id, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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_table_and_wait_for_state(table_name_or_id, update_table_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {}) click to toggle source

Calls {OCI::Nosql::NosqlClient#update_table} and then waits for the {OCI::Nosql::Models::WorkRequest} to enter the given state(s).

@param [String] table_name_or_id A table name within the compartment, or a table OCID. @param [OCI::Nosql::Models::UpdateTableDetails] update_table_details Specifications for the alteration. @param [Array<String>] wait_for_states An array of states to wait on. These should be valid values for {OCI::Nosql::Models::WorkRequest#status} @param [Hash] base_operation_opts Any optional arguments accepted by {OCI::Nosql::NosqlClient#update_table} @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::Nosql::Models::WorkRequest}

# File lib/oci/nosql/nosql_client_composite_operations.rb, line 337
def update_table_and_wait_for_state(table_name_or_id, update_table_details, wait_for_states = [], base_operation_opts = {}, waiter_opts = {})
  operation_result = @service_client.update_table(table_name_or_id, update_table_details, base_operation_opts)
  use_util = OCI::Nosql::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::Nosql::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