DTS Transfer Job Functions

Package: DBMS_CLOUD_OCI_DTS_TRANSFER_JOB

CHANGE_TRANSFER_JOB_COMPARTMENT Function

Moves a TransferJob into a different compartment.

Syntax

FUNCTION change_transfer_job_compartment (
  transfer_job_id varchar2,
  change_transfer_job_compartment_details dbms_cloud_oci_dts_change_transfer_job_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  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_job_change_transfer_job_compartment_response_t;

Parameters

Parameter	Description
`transfer_job_id`	(required) ID of the Transfer Job
`change_transfer_job_compartment_details`	(required) CompartmentId of the destination compartment
`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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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_JOB Function

Create a new Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Syntax

FUNCTION create_transfer_job (
  create_transfer_job_details dbms_cloud_oci_dts_create_transfer_job_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  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_job_create_transfer_job_response_t;

Parameters

Parameter	Description
`create_transfer_job_details`	(required) Creates a New Transfer Job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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_JOB Function

deletes a transfer job

Syntax

FUNCTION delete_transfer_job (
  id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  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_job_delete_transfer_job_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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_JOB Function

Describes a transfer job in detail

Syntax

FUNCTION get_transfer_job (
  id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_job_get_transfer_job_response_t;

Parameters

Parameter	Description
`id`	(required) OCID of the Transfer Job
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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_JOBS Function

Lists Transfer Jobs in a given compartment

Syntax

FUNCTION list_transfer_jobs (
  compartment_id varchar2,
  lifecycle_state varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_job_list_transfer_jobs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) compartment id
`lifecycle_state`	(optional) filtering by lifecycleState Allowed values are: 'INITIATED', 'PREPARING', 'ACTIVE', 'DELETED', 'CLOSED'
`display_name`	(optional) filtering by displayName
`limit`	(optional) For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call. For important details about how pagination works, see List Pagination. Example: `50`
`page`	(optional) For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important details about how pagination works, see List Pagination.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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_JOB Function

Updates a Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Syntax

FUNCTION update_transfer_job (
  id varchar2,
  update_transfer_job_details dbms_cloud_oci_dts_update_transfer_job_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_dts_transfer_job_update_transfer_job_response_t;

Parameters

Parameter	Description
`id`	(required) ID of the Transfer Job
`update_transfer_job_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.
`opc_request_id`	(optional) Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`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

CHANGE_TRANSFER_JOB_COMPARTMENT Function

CREATE_TRANSFER_JOB Function

DELETE_TRANSFER_JOB Function

GET_TRANSFER_JOB Function

LIST_TRANSFER_JOBS Function

UPDATE_TRANSFER_JOB Function