com.oracle.bmc.rover

Interface RoverClusterAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RoverClusterAsyncClient

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

A description of the RoverCloudService API.

Method Summary

Modifier and Type	Method and Description
Future<ChangeRoverClusterCompartmentResponse>	changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request, AsyncHandler<ChangeRoverClusterCompartmentRequest,ChangeRoverClusterCompartmentResponse> handler) Moves a cluster into a different compartment.
Future<CreateRoverClusterResponse>	createRoverCluster(CreateRoverClusterRequest request, AsyncHandler<CreateRoverClusterRequest,CreateRoverClusterResponse> handler) Creates a new RoverCluster.
Future<DeleteRoverClusterResponse>	deleteRoverCluster(DeleteRoverClusterRequest request, AsyncHandler<DeleteRoverClusterRequest,DeleteRoverClusterResponse> handler) Deletes a RoverCluster resource by identifier
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetRoverClusterResponse>	getRoverCluster(GetRoverClusterRequest request, AsyncHandler<GetRoverClusterRequest,GetRoverClusterResponse> handler) Gets a RoverCluster by identifier
Future<GetRoverClusterCertificateResponse>	getRoverClusterCertificate(GetRoverClusterCertificateRequest request, AsyncHandler<GetRoverClusterCertificateRequest,GetRoverClusterCertificateResponse> handler) Get the certificate for a rover cluster
Future<ListRoverClustersResponse>	listRoverClusters(ListRoverClustersRequest request, AsyncHandler<ListRoverClustersRequest,ListRoverClustersResponse> handler) Returns a list of RoverClusters.
void	refreshClient() Rebuilds the client from scratch.
Future<RequestAdditionalNodesResponse>	requestAdditionalNodes(RequestAdditionalNodesRequest request, AsyncHandler<RequestAdditionalNodesRequest,RequestAdditionalNodesResponse> handler) Submit additional nodes request for a roverCluster.
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’).
Future<UpdateRoverClusterResponse>	updateRoverCluster(UpdateRoverClusterRequest request, AsyncHandler<UpdateRoverClusterRequest,UpdateRoverClusterResponse> handler) Updates the RoverCluster
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

changeRoverClusterCompartment

Future<ChangeRoverClusterCompartmentResponse> changeRoverClusterCompartment(ChangeRoverClusterCompartmentRequest request,
                                                                            AsyncHandler<ChangeRoverClusterCompartmentRequest,ChangeRoverClusterCompartmentResponse> handler)

Moves a cluster into a different compartment.

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.

createRoverCluster

Future<CreateRoverClusterResponse> createRoverCluster(CreateRoverClusterRequest request,
                                                      AsyncHandler<CreateRoverClusterRequest,CreateRoverClusterResponse> handler)

Creates a new RoverCluster.

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.

deleteRoverCluster

Future<DeleteRoverClusterResponse> deleteRoverCluster(DeleteRoverClusterRequest request,
                                                      AsyncHandler<DeleteRoverClusterRequest,DeleteRoverClusterResponse> handler)

Deletes a RoverCluster resource by identifier

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.

getRoverCluster

Future<GetRoverClusterResponse> getRoverCluster(GetRoverClusterRequest request,
                                                AsyncHandler<GetRoverClusterRequest,GetRoverClusterResponse> handler)

Gets a RoverCluster by identifier

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.

getRoverClusterCertificate

Future<GetRoverClusterCertificateResponse> getRoverClusterCertificate(GetRoverClusterCertificateRequest request,
                                                                      AsyncHandler<GetRoverClusterCertificateRequest,GetRoverClusterCertificateResponse> handler)

Get the certificate for a rover cluster

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.

listRoverClusters

Future<ListRoverClustersResponse> listRoverClusters(ListRoverClustersRequest request,
                                                    AsyncHandler<ListRoverClustersRequest,ListRoverClustersResponse> handler)

Returns a list of RoverClusters.

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.

requestAdditionalNodes

Future<RequestAdditionalNodesResponse> requestAdditionalNodes(RequestAdditionalNodesRequest request,
                                                              AsyncHandler<RequestAdditionalNodesRequest,RequestAdditionalNodesResponse> handler)

Submit additional nodes request for a roverCluster.

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.

updateRoverCluster

Future<UpdateRoverClusterResponse> updateRoverCluster(UpdateRoverClusterRequest request,
                                                      AsyncHandler<UpdateRoverClusterRequest,UpdateRoverClusterResponse> handler)

Updates the RoverCluster

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.