DTS Transfer Package Functions

Package: DBMS_CLOUD_OCI_DTS_TRANSFER_PACKAGE

ATTACH_DEVICES_TO_TRANSFER_PACKAGE Function

Attaches Devices to a Transfer Package

Syntax

FUNCTION attach_devices_to_transfer_package (
  id varchar2,
  transfer_package_label varchar2,
  attach_devices_details dbms_cloud_oci_dts_attach_devices_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_package_attach_devices_to_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`transfer_package_label`	(required) Label of the Transfer Package
`attach_devices_details`	(required) Labels of Transfer Devices to attach
`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.

CREATE_TRANSFER_PACKAGE Function

Create a new Transfer Package

Syntax

FUNCTION create_transfer_package (
  id varchar2,
  opc_retry_token varchar2 DEFAULT NULL,
  create_transfer_package_details dbms_cloud_oci_dts_create_transfer_package_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_package_create_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`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).
`create_transfer_package_details`	(optional) Creates a New Transfer Package
`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_PACKAGE Function

deletes a transfer Package

Syntax

FUNCTION delete_transfer_package (
  id varchar2,
  transfer_package_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_package_delete_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`transfer_package_label`	(required) Label of the Transfer Package
`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.

DETACH_DEVICES_FROM_TRANSFER_PACKAGE Function

Detaches Devices from a Transfer Package

Syntax

FUNCTION detach_devices_from_transfer_package (
  id varchar2,
  transfer_package_label varchar2,
  detach_devices_details dbms_cloud_oci_dts_detach_devices_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_package_detach_devices_from_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`transfer_package_label`	(required) Label of the Transfer Package
`detach_devices_details`	(required) Labels of Transfer Devices to detach
`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_PACKAGE Function

Describes a transfer package in detail

Syntax

FUNCTION get_transfer_package (
  id varchar2,
  transfer_package_label varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_package_get_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`transfer_package_label`	(required) Label of the Transfer Package
`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_PACKAGES Function

Lists Transfer Packages associated with a transferJob

Syntax

FUNCTION list_transfer_packages (
  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_package_list_transfer_packages_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`lifecycle_state`	(optional) filtering by lifecycleState Allowed values are: 'PREPARING', 'SHIPPING', 'RECEIVED', 'PROCESSING', 'PROCESSED', 'RETURNED', 'DELETED', 'CANCELLED', 'CANCELLED_RETURNED'
`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_PACKAGE Function

Updates a Transfer Package

Syntax

FUNCTION update_transfer_package (
  id varchar2,
  transfer_package_label varchar2,
  update_transfer_package_details dbms_cloud_oci_dts_update_transfer_package_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_package_update_transfer_package_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`transfer_package_label`	(required) Label of the Transfer Package
`update_transfer_package_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.

Oracle Cloud Infrastructure Documentation

ATTACH_DEVICES_TO_TRANSFER_PACKAGE Function

CREATE_TRANSFER_PACKAGE Function

DELETE_TRANSFER_PACKAGE Function

DETACH_DEVICES_FROM_TRANSFER_PACKAGE Function

GET_TRANSFER_PACKAGE Function

LIST_TRANSFER_PACKAGES Function

UPDATE_TRANSFER_PACKAGE Function