Oracle Cloud Infrastructure Documentation
Try Free Tier

DTS Transfer Device Functions

Package: DBMS_CLOUD_OCI_DTS_TRANSFER_DEVICE

CREATE_TRANSFER_DEVICE Function

Create a new Transfer Device

Syntax

FUNCTION create_transfer_device (
  id varchar2,
  create_transfer_device_details dbms_cloud_oci_dts_create_transfer_device_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_device_create_transfer_device_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

create_transfer_device_details

(required) Creates a New Transfer Device

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TRANSFER_DEVICE Function

deletes a transfer Device

Syntax

FUNCTION delete_transfer_device (
  id varchar2,
  transfer_device_label varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_device_delete_transfer_device_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_device_label

(required) Label of the Transfer Device

opc_retry_token

(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (e.g., if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TRANSFER_DEVICE Function

Describes a transfer package in detail

Syntax

FUNCTION get_transfer_device (
  id varchar2,
  transfer_device_label varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_device_get_transfer_device_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_device_label

(required) Label of the Transfer Device

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TRANSFER_DEVICES Function

Lists Transfer Devices associated with a transferJob

Syntax

FUNCTION list_transfer_devices (
  id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_device_list_transfer_devices_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

lifecycle_state

(optional) filtering by lifecycleState

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

display_name

(optional) filtering by displayName

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TRANSFER_DEVICE Function

Updates a Transfer Device

Syntax

FUNCTION update_transfer_device (
  id varchar2,
  transfer_device_label varchar2,
  update_transfer_device_details dbms_cloud_oci_dts_update_transfer_device_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_device_update_transfer_device_response_t;

Parameters

Parameter Description

id

(required) ID of the Transfer Job

transfer_device_label

(required) Label of the Transfer Device

update_transfer_device_details

(required) fields to update

if_match

(optional) 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.

region

(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).

endpoint

(optional) The endpoint of the service to call using this function. e.g https://datatransfer.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.

credential_name

(optional) The name of the credential for authenticating with the corresponding cloud native API.

Was this article helpful?