Oracle Cloud Infrastructure Documentation
Try Free Tier

Roving Edge Infrastructure Bundle Functions

Package: DBMS_CLOUD_OCI_RV_ROVER_BUNDLE

LIST_ROVER_CLUSTER_ROVER_BUNDLE_REQUESTS Function

List all the roverBundleRequests for a given roverClusterId.

Syntax

FUNCTION list_rover_cluster_rover_bundle_requests (
  rover_cluster_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_bundle_list_rover_cluster_rover_bundle_requests_response_t;

Parameters

Parameter Description

rover_cluster_id

(required) Unique RoverCluster identifier

opc_request_id

(optional) The client request ID for tracing.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default.

Allowed values are: 'timeTaskCreated'

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://rover.{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_ROVER_NODE_ROVER_BUNDLE_REQUESTS Function

List all the roverBundleRequests for a given roverNodeId.

Syntax

FUNCTION list_rover_node_rover_bundle_requests (
  rover_node_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_rv_rover_bundle_list_rover_node_rover_bundle_requests_response_t;

Parameters

Parameter Description

rover_node_id

(required) Unique RoverNode identifier

opc_request_id

(optional) The client request ID for tracing.

limit

(optional) The maximum number of items to return.

page

(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

sort_order

(optional) The sort order to use, either 'asc' or 'desc'.

Allowed values are: 'ASC', 'DESC'

sort_by

(optional) The field to sort by. Only one sort order may be provided. Default order for timeTaskCreated is descending. If no value is specified timeTaskCreated is default.

Allowed values are: 'timeTaskCreated'

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://rover.{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.

REQUEST_BUNDLE_ROVER_CLUSTER Function

Request to get rover bundle to the bucket in customer's tenancy.

Syntax

FUNCTION request_bundle_rover_cluster (
  request_rover_bundle_details dbms_cloud_oci_rover_request_rover_bundle_details_t,
  rover_cluster_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_rv_rover_bundle_request_bundle_rover_cluster_response_t;

Parameters

Parameter Description

request_rover_bundle_details

(required) Request the rover bundle details.

rover_cluster_id

(required) Unique RoverCluster identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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.

REQUEST_BUNDLE_ROVER_NODE Function

Request to get rover bundle to the bucket in customer's tenancy.

Syntax

FUNCTION request_bundle_rover_node (
  request_rover_bundle_details dbms_cloud_oci_rover_request_rover_bundle_details_t,
  rover_node_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_rv_rover_bundle_request_bundle_rover_node_response_t;

Parameters

Parameter Description

request_rover_bundle_details

(required) Request the rover bundle details.

rover_node_id

(required) Unique RoverNode identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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.

RETRIEVE_AVAILABLE_BUNDLE_VERSIONS_ROVER_CLUSTER Function

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Syntax

FUNCTION retrieve_available_bundle_versions_rover_cluster (
  current_rover_bundle_details dbms_cloud_oci_rover_current_rover_bundle_details_t,
  rover_cluster_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_rv_rover_bundle_retrieve_available_bundle_versions_rover_cluster_response_t;

Parameters

Parameter Description

current_rover_bundle_details

(required) Provide the current rover bundle details.

rover_cluster_id

(required) Unique RoverCluster identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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.

RETRIEVE_AVAILABLE_BUNDLE_VERSIONS_ROVER_NODE Function

Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.

Syntax

FUNCTION retrieve_available_bundle_versions_rover_node (
  current_rover_bundle_details dbms_cloud_oci_rover_current_rover_bundle_details_t,
  rover_node_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_rv_rover_bundle_retrieve_available_bundle_versions_rover_node_response_t;

Parameters

Parameter Description

current_rover_bundle_details

(required) Provide the current rover bundle details.

rover_node_id

(required) Unique RoverNode identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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.

RETRIEVE_BUNDLE_STATUS_ROVER_CLUSTER Function

Retrieve the status and progress of a rover bundle copy request.

Syntax

FUNCTION retrieve_bundle_status_rover_cluster (
  rover_bundle_status_details dbms_cloud_oci_rover_rover_bundle_status_details_t,
  rover_cluster_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_rv_rover_bundle_retrieve_bundle_status_rover_cluster_response_t;

Parameters

Parameter Description

rover_bundle_status_details

(required) Provide the rover bundle details that requires to retrieve its status.

rover_cluster_id

(required) Unique RoverCluster identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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.

RETRIEVE_BUNDLE_STATUS_ROVER_NODE Function

Retrieve the status and progress of a rover bundle copy request.

Syntax

FUNCTION retrieve_bundle_status_rover_node (
  rover_bundle_status_details dbms_cloud_oci_rover_rover_bundle_status_details_t,
  rover_node_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_rv_rover_bundle_retrieve_bundle_status_rover_node_response_t;

Parameters

Parameter Description

rover_bundle_status_details

(required) Provide the rover bundle details that requires to retrieve its status.

rover_node_id

(required) Unique RoverNode identifier

opc_request_id

(optional) The client request ID for tracing.

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://rover.{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?