Package com.oracle.bmc.rover

Interface RoverBundleAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverBundleAsyncClient

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

A description of the RoverCloudService API.

Method Summary

Modifier and Type	Method	Description
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListRoverClusterRoverBundleRequestsResponse>	listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request, AsyncHandler<ListRoverClusterRoverBundleRequestsRequest,ListRoverClusterRoverBundleRequestsResponse> handler)	List all the roverBundleRequests for a given roverClusterId.
Future<ListRoverNodeRoverBundleRequestsResponse>	listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request, AsyncHandler<ListRoverNodeRoverBundleRequestsRequest,ListRoverNodeRoverBundleRequestsResponse> handler)	List all the roverBundleRequests for a given roverNodeId.
void	refreshClient()	Rebuilds the client from scratch.
Future<RequestBundleRoverClusterResponse>	requestBundleRoverCluster(RequestBundleRoverClusterRequest request, AsyncHandler<RequestBundleRoverClusterRequest,RequestBundleRoverClusterResponse> handler)	Request to get rover bundle to the bucket in customer’s tenancy.
Future<RequestBundleRoverNodeResponse>	requestBundleRoverNode(RequestBundleRoverNodeRequest request, AsyncHandler<RequestBundleRoverNodeRequest,RequestBundleRoverNodeResponse> handler)	Request to get rover bundle to the bucket in customer’s tenancy.
Future<RetrieveAvailableBundleVersionsRoverClusterResponse>	retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request, AsyncHandler<RetrieveAvailableBundleVersionsRoverClusterRequest,RetrieveAvailableBundleVersionsRoverClusterResponse> handler)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Future<RetrieveAvailableBundleVersionsRoverNodeResponse>	retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request, AsyncHandler<RetrieveAvailableBundleVersionsRoverNodeRequest,RetrieveAvailableBundleVersionsRoverNodeResponse> handler)	Retrieve the latest available rover bundle version that can be upgraded to based on current bundle version.
Future<RetrieveBundleStatusRoverClusterResponse>	retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request, AsyncHandler<RetrieveBundleStatusRoverClusterRequest,RetrieveBundleStatusRoverClusterResponse> handler)	Retrieve the status and progress of a rover bundle copy request.
Future<RetrieveBundleStatusRoverNodeResponse>	retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request, AsyncHandler<RetrieveBundleStatusRoverNodeRequest,RetrieveBundleStatusRoverNodeResponse> handler)	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 serice.

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

Future<ListRoverClusterRoverBundleRequestsResponse> listRoverClusterRoverBundleRequests(ListRoverClusterRoverBundleRequestsRequest request,
                                                                                        AsyncHandler<ListRoverClusterRoverBundleRequestsRequest,ListRoverClusterRoverBundleRequestsResponse> handler)

List all the roverBundleRequests for a given roverClusterId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listRoverNodeRoverBundleRequests

Future<ListRoverNodeRoverBundleRequestsResponse> listRoverNodeRoverBundleRequests(ListRoverNodeRoverBundleRequestsRequest request,
                                                                                  AsyncHandler<ListRoverNodeRoverBundleRequestsRequest,ListRoverNodeRoverBundleRequestsResponse> handler)

List all the roverBundleRequests for a given roverNodeId.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

requestBundleRoverCluster

Future<RequestBundleRoverClusterResponse> requestBundleRoverCluster(RequestBundleRoverClusterRequest request,
                                                                    AsyncHandler<RequestBundleRoverClusterRequest,RequestBundleRoverClusterResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

requestBundleRoverNode

Future<RequestBundleRoverNodeResponse> requestBundleRoverNode(RequestBundleRoverNodeRequest request,
                                                              AsyncHandler<RequestBundleRoverNodeRequest,RequestBundleRoverNodeResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retrieveAvailableBundleVersionsRoverCluster

Future<RetrieveAvailableBundleVersionsRoverClusterResponse> retrieveAvailableBundleVersionsRoverCluster(RetrieveAvailableBundleVersionsRoverClusterRequest request,
                                                                                                        AsyncHandler<RetrieveAvailableBundleVersionsRoverClusterRequest,RetrieveAvailableBundleVersionsRoverClusterResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retrieveAvailableBundleVersionsRoverNode

Future<RetrieveAvailableBundleVersionsRoverNodeResponse> retrieveAvailableBundleVersionsRoverNode(RetrieveAvailableBundleVersionsRoverNodeRequest request,
                                                                                                  AsyncHandler<RetrieveAvailableBundleVersionsRoverNodeRequest,RetrieveAvailableBundleVersionsRoverNodeResponse> handler)

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

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retrieveBundleStatusRoverCluster

Future<RetrieveBundleStatusRoverClusterResponse> retrieveBundleStatusRoverCluster(RetrieveBundleStatusRoverClusterRequest request,
                                                                                  AsyncHandler<RetrieveBundleStatusRoverClusterRequest,RetrieveBundleStatusRoverClusterResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

retrieveBundleStatusRoverNode

Future<RetrieveBundleStatusRoverNodeResponse> retrieveBundleStatusRoverNode(RetrieveBundleStatusRoverNodeRequest request,
                                                                            AsyncHandler<RetrieveBundleStatusRoverNodeRequest,RetrieveBundleStatusRoverNodeResponse> handler)

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

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.