class OCI::Dts::TransferDeviceClient

Data Transfer Service API Specification

Attributes

api_client[R]

Client used to make HTTP requests. @return [OCI::ApiClient]

endpoint[R]

Fully qualified endpoint URL @return [String]

region[R]

The region, which will usually correspond to a value in {OCI::Regions::REGION_ENUM}. @return [String]

retry_config[R]

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation will not perform any retries @return [OCI::Retry::RetryConfig]

Public Class Methods

new(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) click to toggle source

Creates a new TransferDeviceClient. Notes:

If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified.  If an endpoint is specified, it will be used instead of the
  region. A region may be specified in the config or via or the region parameter. If specified in both, then the
  region parameter will be used.

@param [Config] config A Config object. @param [String] region A region used to determine the service endpoint. This will usually

correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

@param [String] endpoint The fully qualified endpoint URL @param [OCI::BaseSigner] signer A signer implementation which can be used by this client. If this is not provided then

a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication,
so that the instance principals signer can be provided to the client

@param [OCI::ApiClientProxySettings] proxy_settings If your environment requires you to use a proxy server for outgoing HTTP requests

the details for the proxy can be provided in this parameter

@param [OCI::Retry::RetryConfig] retry_config The retry configuration for this service client. This represents the default retry configuration to

apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is `nil`, which means that an operation
will not perform any retries
# File lib/oci/dts/transfer_device_client.rb, line 53
def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20171001'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "TransferDeviceClient endpoint set to '#{@endpoint}'." if logger
end

Public Instance Methods

create_transfer_device(id, create_transfer_device_details, opts = {}) click to toggle source

Create a new Transfer Device @param [String] id ID of the Transfer Job @param [OCI::Dts::Models::CreateTransferDeviceDetails] create_transfer_device_details Creates a New Transfer Device @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :opc_retry_token @return [Response] A Response object with data of type {OCI::Dts::Models::NewTransferDevice NewTransferDevice} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/create_transfer_device.rb.html) to see an example of how to use create_transfer_device API.

# File lib/oci/dts/transfer_device_client.rb, line 110
def create_transfer_device(id, create_transfer_device_details, opts = {})
  logger.debug 'Calling operation TransferDeviceClient#create_transfer_device.' if logger

  raise "Missing the required parameter 'id' when calling create_transfer_device." if id.nil?
  raise "Missing the required parameter 'create_transfer_device_details' when calling create_transfer_device." if create_transfer_device_details.nil?
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)

  path = '/transferJobs/{id}/transferDevices'.sub('{id}', id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_transfer_device_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferDeviceClient#create_transfer_device') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dts::Models::NewTransferDevice'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
delete_transfer_device(id, transfer_device_label, opts = {}) click to toggle source

deletes a transfer Device @param [String] id ID of the Transfer Job @param [String] transfer_device_label Label of the Transfer Device @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@return [Response] A Response object with data of type nil @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/delete_transfer_device.rb.html) to see an example of how to use delete_transfer_device API.

# File lib/oci/dts/transfer_device_client.rb, line 167
def delete_transfer_device(id, transfer_device_label, opts = {})
  logger.debug 'Calling operation TransferDeviceClient#delete_transfer_device.' if logger

  raise "Missing the required parameter 'id' when calling delete_transfer_device." if id.nil?
  raise "Missing the required parameter 'transfer_device_label' when calling delete_transfer_device." if transfer_device_label.nil?
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)
  raise "Parameter value for 'transfer_device_label' must not be blank" if OCI::Internal::Util.blank_string?(transfer_device_label)

  path = '/transferJobs/{id}/transferDevices/{transferDeviceLabel}'.sub('{id}', id.to_s).sub('{transferDeviceLabel}', transfer_device_label.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferDeviceClient#delete_transfer_device') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end
get_transfer_device(id, transfer_device_label, opts = {}) click to toggle source

Describes a transfer package in detail @param [String] id ID of the Transfer Job @param [String] transfer_device_label Label of the Transfer Device @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@return [Response] A Response object with data of type {OCI::Dts::Models::TransferDevice TransferDevice} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/get_transfer_device.rb.html) to see an example of how to use get_transfer_device API.

# File lib/oci/dts/transfer_device_client.rb, line 223
def get_transfer_device(id, transfer_device_label, opts = {})
  logger.debug 'Calling operation TransferDeviceClient#get_transfer_device.' if logger

  raise "Missing the required parameter 'id' when calling get_transfer_device." if id.nil?
  raise "Missing the required parameter 'transfer_device_label' when calling get_transfer_device." if transfer_device_label.nil?
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)
  raise "Parameter value for 'transfer_device_label' must not be blank" if OCI::Internal::Util.blank_string?(transfer_device_label)

  path = '/transferJobs/{id}/transferDevices/{transferDeviceLabel}'.sub('{id}', id.to_s).sub('{transferDeviceLabel}', transfer_device_label.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferDeviceClient#get_transfer_device') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dts::Models::TransferDevice'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
list_transfer_devices(id, opts = {}) click to toggle source

Lists Transfer Devices associated with a transferJob @param [String] id ID of the Transfer Job @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :lifecycle_state filtering by lifecycleState

Allowed values are: PREPARING, READY, PACKAGED, ACTIVE, PROCESSING, COMPLETE, MISSING, ERROR, DELETED, CANCELLED

@option opts [String] :display_name filtering by displayName @return [Response] A Response object with data of type {OCI::Dts::Models::MultipleTransferDevices MultipleTransferDevices} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/list_transfer_devices.rb.html) to see an example of how to use list_transfer_devices API.

# File lib/oci/dts/transfer_device_client.rb, line 281
def list_transfer_devices(id, opts = {})
  logger.debug 'Calling operation TransferDeviceClient#list_transfer_devices.' if logger

  raise "Missing the required parameter 'id' when calling list_transfer_devices." if id.nil?

  if opts[:lifecycle_state] && !%w[PREPARING READY PACKAGED ACTIVE PROCESSING COMPLETE MISSING ERROR DELETED CANCELLED].include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of PREPARING, READY, PACKAGED, ACTIVE, PROCESSING, COMPLETE, MISSING, ERROR, DELETED, CANCELLED.'
  end
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)

  path = '/transferJobs/{id}/transferDevices'.sub('{id}', id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferDeviceClient#list_transfer_devices') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dts::Models::MultipleTransferDevices'
    )
  end
  # rubocop:enable Metrics/BlockLength
end
logger() click to toggle source

@return [Logger] The logger for this client. May be nil.

# File lib/oci/dts/transfer_device_client.rb, line 92
def logger
  @api_client.config.logger
end
region=(new_region) click to toggle source

Set the region that will be used to determine the service endpoint. This will usually correspond to a value in {OCI::Regions::REGION_ENUM}, but may be an arbitrary string.

# File lib/oci/dts/transfer_device_client.rb, line 82
def region=(new_region)
  @region = new_region

  raise 'A region must be specified.' unless @region

  @endpoint = OCI::Regions.get_service_endpoint_for_template(@region, 'https://datatransfer.{region}.oci.{secondLevelDomain}') + '/20171001'
  logger.info "TransferDeviceClient endpoint set to '#{@endpoint} from region #{@region}'." if logger
end
update_transfer_device(id, transfer_device_label, update_transfer_device_details, opts = {}) click to toggle source

Updates a Transfer Device @param [String] id ID of the Transfer Job @param [String] transfer_device_label Label of the Transfer Device @param [OCI::Dts::Models::UpdateTransferDeviceDetails] update_transfer_device_details fields to update @param [Hash] opts the optional parameters @option opts [OCI::Retry::RetryConfig] :retry_config The retry configuration to apply to this operation. If no key is provided then the service-level

retry configuration defined by {#retry_config} will be used. If an explicit `nil` value is provided then the operation will not retry

@option opts [String] :if_match The entity tag to match. Optional, if set, the update will be successful only if the

object's tag matches the tag specified in the request.

@return [Response] A Response object with data of type {OCI::Dts::Models::TransferDevice TransferDevice} @note Click [here](docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/update_transfer_device.rb.html) to see an example of how to use update_transfer_device API.

# File lib/oci/dts/transfer_device_client.rb, line 344
def update_transfer_device(id, transfer_device_label, update_transfer_device_details, opts = {})
  logger.debug 'Calling operation TransferDeviceClient#update_transfer_device.' if logger

  raise "Missing the required parameter 'id' when calling update_transfer_device." if id.nil?
  raise "Missing the required parameter 'transfer_device_label' when calling update_transfer_device." if transfer_device_label.nil?
  raise "Missing the required parameter 'update_transfer_device_details' when calling update_transfer_device." if update_transfer_device_details.nil?
  raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)
  raise "Parameter value for 'transfer_device_label' must not be blank" if OCI::Internal::Util.blank_string?(transfer_device_label)

  path = '/transferJobs/{id}/transferDevices/{transferDeviceLabel}'.sub('{id}', id.to_s).sub('{transferDeviceLabel}', transfer_device_label.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_transfer_device_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferDeviceClient#update_transfer_device') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::Dts::Models::TransferDevice'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

Private Instance Methods

applicable_retry_config(opts = {}) click to toggle source

rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity rubocop:enable Style/IfUnlessModifier, Metrics/ParameterLists rubocop:enable Metrics/MethodLength, Layout/EmptyLines

# File lib/oci/dts/transfer_device_client.rb, line 390
def applicable_retry_config(opts = {})
  return @retry_config unless opts.key?(:retry_config)

  opts[:retry_config]
end