lib/oci/dts/transfer_appliance_client.rb
# Lists Transfer Appliances 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: REQUESTED, ORACLE_PREPARING, SHIPPING, DELIVERED, PREPARING, FINALIZED, RETURN_DELAYED, RETURN_SHIPPED, RETURN_SHIPPED_CANCELLED, ORACLE_RECEIVED, ORACLE_RECEIVED_CANCELLED, PROCESSING, COMPLETE, CUSTOMER_NEVER_RECEIVED, ORACLE_NEVER_RECEIVED, CUSTOMER_LOST, CANCELLED, DELETED, REJECTED, ERROR
# @return [Response] A Response object with data of type {OCI::Dts::Models::MultipleTransferAppliances MultipleTransferAppliances}
# @note Click [here](https://docs.cloud.oracle.com/en-us/iaas/tools/ruby-sdk-examples/latest/dts/list_transfer_appliances.rb.html) to see an example of how to use list_transfer_appliances API.
Lists Transfer Appliances associated with a transferJob
Lists Transfer Appliances associated with a transferJob
def list_transfer_appliances(id, opts = {})
      logger.debug 'Calling operation TransferApplianceClient#list_transfer_appliances.' if logger
      raise "Missing the required parameter 'id' when calling list_transfer_appliances." if id.nil?
      if opts[:lifecycle_state] && !%w[REQUESTED ORACLE_PREPARING SHIPPING DELIVERED PREPARING FINALIZED RETURN_DELAYED RETURN_SHIPPED RETURN_SHIPPED_CANCELLED ORACLE_RECEIVED ORACLE_RECEIVED_CANCELLED PROCESSING COMPLETE CUSTOMER_NEVER_RECEIVED ORACLE_NEVER_RECEIVED CUSTOMER_LOST CANCELLED DELETED REJECTED ERROR].include?(opts[:lifecycle_state])
        raise 'Invalid value for "lifecycle_state", must be one of REQUESTED, ORACLE_PREPARING, SHIPPING, DELIVERED, PREPARING, FINALIZED, RETURN_DELAYED, RETURN_SHIPPED, RETURN_SHIPPED_CANCELLED, ORACLE_RECEIVED, ORACLE_RECEIVED_CANCELLED, PROCESSING, COMPLETE, CUSTOMER_NEVER_RECEIVED, ORACLE_NEVER_RECEIVED, CUSTOMER_LOST, CANCELLED, DELETED, REJECTED, ERROR.'
      end
      raise "Parameter value for 'id' must not be blank" if OCI::Internal::Util.blank_string?(id)
      path = '/transferJobs/{id}/transferAppliances'.sub('{id}', id.to_s)
      operation_signing_strategy = :standard
      query_params = {}
      query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
      header_params = {}
      header_params[:accept] = 'application/json'
      header_params[:'content-type'] = 'application/json'
      post_body = nil
      OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'TransferApplianceClient#list_transfer_appliances') 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::MultipleTransferAppliances'
        )
      end
    end
def list_transfer_appliances ( id , opts = { } ) logger . debug 'Calling operation TransferApplianceClient#list_transfer_appliances.' if logger raise "Missing the required parameter 'id' when calling list_transfer_appliances." if id . nil? if opts [ :lifecycle_state ] && ! %w[ REQUESTED ORACLE_PREPARING SHIPPING DELIVERED PREPARING FINALIZED RETURN_DELAYED RETURN_SHIPPED RETURN_SHIPPED_CANCELLED ORACLE_RECEIVED ORACLE_RECEIVED_CANCELLED PROCESSING COMPLETE CUSTOMER_NEVER_RECEIVED ORACLE_NEVER_RECEIVED CUSTOMER_LOST CANCELLED DELETED REJECTED ERROR ] . include? ( opts [ :lifecycle_state ] ) raise 'Invalid value for "lifecycle_state", must be one of REQUESTED, ORACLE_PREPARING, SHIPPING, DELIVERED, PREPARING, FINALIZED, RETURN_DELAYED, RETURN_SHIPPED, RETURN_SHIPPED_CANCELLED, ORACLE_RECEIVED, ORACLE_RECEIVED_CANCELLED, PROCESSING, COMPLETE, CUSTOMER_NEVER_RECEIVED, ORACLE_NEVER_RECEIVED, CUSTOMER_LOST, CANCELLED, DELETED, REJECTED, ERROR.' end raise "Parameter value for 'id' must not be blank" if OCI :: Internal :: Util . blank_string? ( id ) path = '/transferJobs/{id}/transferAppliances' . sub ( '{id}' , id . to_s ) operation_signing_strategy = :standard query_params = { } query_params [ :lifecycleState ] = opts [ :lifecycle_state ] if opts [ :lifecycle_state ] header_params = { } header_params [ :accept ] = 'application/json' header_params [ :' content-type ' ] = 'application/json' post_body = nil OCI :: Retry . make_retrying_call ( applicable_retry_config ( opts ) , call_name : 'TransferApplianceClient#list_transfer_appliances' ) 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::MultipleTransferAppliances' ) end end
Lists Transfer Appliances associated with a transferJob
Lists Transfer Appliances associated with a transferJob
# rubocop:disable Style/NegatedIf # Query Params # Header Params # rubocop:enable Style/NegatedIf # rubocop:disable Metrics/BlockLength # rubocop:enable Metrics/BlockLength
A Response object with data of type {OCI::Dts::Models::MultipleTransferAppliances MultipleTransferAppliances}
A Response object with data of type { OCI :: Dts :: Models :: MultipleTransferAppliances MultipleTransferAppliances }
Response
id
<not_specific>
opts
None
<not_specific>
opts the optional parameters
opts the optional parameters
note
Click [here] to see an example of how to use list_transfer_appliances API.
Click [ here ] to see an example of how to use list_transfer_appliances API .