Oracle Cloud Infrastructure Documentation
Try Free Tier

DTS Transfer Appliance Entitlement Functions

Package: DBMS_CLOUD_OCI_DTS_TRANSFER_APPLIANCE_ENTITLEMENT

CREATE_TRANSFER_APPLIANCE_ENTITLEMENT Function

Create the Entitlement to use a Transfer Appliance. It requires some offline process of review and signatures before request is granted.

Syntax

FUNCTION create_transfer_appliance_entitlement (
  create_transfer_appliance_entitlement_details dbms_cloud_oci_dts_create_transfer_appliance_entitlement_details_t,
  opc_retry_token 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_appliance_entitlement_create_transfer_appliance_entitlement_response_t;

Parameters

Parameter Description

create_transfer_appliance_entitlement_details

(required) Creates a Transfer Appliance Entitlement

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

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.

GET_TRANSFER_APPLIANCE_ENTITLEMENT Function

Describes the Transfer Appliance Entitlement in detail

Syntax

FUNCTION get_transfer_appliance_entitlement (
  id varchar2,
  opc_retry_token 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_appliance_entitlement_get_transfer_appliance_entitlement_response_t;

Parameters

Parameter Description

id

(required) Id of the Transfer Appliance Entitlement

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

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_APPLIANCE_ENTITLEMENT Function

Lists Transfer Transfer Appliance Entitlement

Syntax

FUNCTION list_transfer_appliance_entitlement (
  compartment_id varchar2,
  id varchar2 DEFAULT NULL,
  display_name 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_appliance_entitlement_list_transfer_appliance_entitlement_response_t;

Parameters

Parameter Description

compartment_id

(required) compartment id

id

(optional) filtering by Transfer Appliance Entitlement id

display_name

(optional) filtering by displayName

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.

Was this article helpful?