com.oracle.bmc.rover

Interface RoverBundle

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverBundleClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20201210")
public interface RoverBundle
extends AutoCloseable

A description of the RoverCloudService API. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
RoverBundlePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListRoverClusterRoverBundleRequestsResponse	listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request) List all the roverBundleRequests for a given roverClusterId.
ListRoverNodeRoverBundleRequestsResponse	listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request) List all the roverBundleRequests for a given roverNodeId.
void	refreshClient() Rebuilds the client from scratch.
RequestBundleRoverClusterResponse	requestBundleRoverCluster(RequestBundleRoverClusterRequest request) Request to get rover bundle to the bucket in customer’s tenancy.
RequestBundleRoverNodeResponse	requestBundleRoverNode(RequestBundleRoverNodeRequest request) Request to get rover bundle to the bucket in customer’s tenancy.
RetrieveAvailableBundleVersionsRoverClusterResponse	retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request) Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
RetrieveAvailableBundleVersionsRoverNodeResponse	retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request) Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
RetrieveBundleStatusRoverClusterResponse	retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request) Retrieve the status and progress of a rover bundle copy request.
RetrieveBundleStatusRoverNodeResponse	retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request) Retrieve the status and progress of a rover bundle copy request.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Parameters:

regionId - The public region ID.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

listRoverClusterRoverBundleRequests

ListRoverClusterRoverBundleRequestsResponse listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request)

List all the roverBundleRequests for a given roverClusterId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRoverClusterRoverBundleRequests API.

listRoverNodeRoverBundleRequests

ListRoverNodeRoverBundleRequestsResponse listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request)

List all the roverBundleRequests for a given roverNodeId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListRoverNodeRoverBundleRequests API.

requestBundleRoverCluster

RequestBundleRoverClusterResponse requestBundleRoverCluster(RequestBundleRoverClusterRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RequestBundleRoverCluster API.

requestBundleRoverNode

RequestBundleRoverNodeResponse requestBundleRoverNode(RequestBundleRoverNodeRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RequestBundleRoverNode API.

retrieveAvailableBundleVersionsRoverCluster

RetrieveAvailableBundleVersionsRoverClusterResponse retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RetrieveAvailableBundleVersionsRoverCluster API.

retrieveAvailableBundleVersionsRoverNode

RetrieveAvailableBundleVersionsRoverNodeResponse retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RetrieveAvailableBundleVersionsRoverNode API.

retrieveBundleStatusRoverCluster

RetrieveBundleStatusRoverClusterResponse retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RetrieveBundleStatusRoverCluster API.

retrieveBundleStatusRoverNode

RetrieveBundleStatusRoverNodeResponse retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use RetrieveBundleStatusRoverNode API.

getPaginators

RoverBundlePaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.