com.oracle.bmc.ocvp

Interface ClusterAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ClusterAsyncClient

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

Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software. For more information, see Oracle Cloud VMware Solution.

Method Summary

Modifier and Type	Method and Description
Future<CreateClusterResponse>	createCluster(CreateClusterRequest request, AsyncHandler<CreateClusterRequest,CreateClusterResponse> handler) Create a vSphere Cluster in software-defined data center (SDDC).
Future<DeleteClusterResponse>	deleteCluster(DeleteClusterRequest request, AsyncHandler<DeleteClusterRequest,DeleteClusterResponse> handler) Deletes the specified Cluster, along with the other resources that were created with the Cluster.
Future<GetClusterResponse>	getCluster(GetClusterRequest request, AsyncHandler<GetClusterRequest,GetClusterResponse> handler) Gets the specified Cluster’s information.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListClustersResponse>	listClusters(ListClustersRequest request, AsyncHandler<ListClustersRequest,ListClustersResponse> handler) Lists the Clusters in the specified compartment.
void	refreshClient() Rebuilds the client from scratch.
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<UpdateClusterResponse>	updateCluster(UpdateClusterRequest request, AsyncHandler<UpdateClusterRequest,UpdateClusterResponse> handler) Updates the specified Cluster.
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

createCluster

Future<CreateClusterResponse> createCluster(CreateClusterRequest request,
                                            AsyncHandler<CreateClusterRequest,CreateClusterResponse> handler)

Create a vSphere Cluster in software-defined data center (SDDC).

Use the WorkRequest operations to track the creation of the Cluster.

*Important:** You must configure the Cluster's networking resources with the security rules detailed in [Security Rules for Oracle Cloud VMware Solution SDDCs](https://docs.cloud.oracle.com/iaas/Content/VMware/Reference/ocvssecurityrules.htm). Otherwise, provisioning the SDDC will fail. The rules are based on the requirements set by VMware.

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.

deleteCluster

Future<DeleteClusterResponse> deleteCluster(DeleteClusterRequest request,
                                            AsyncHandler<DeleteClusterRequest,DeleteClusterResponse> handler)

Deletes the specified Cluster, along with the other resources that were created with the Cluster. For example: the Compute instances, DNS records, and so on.

Use the WorkRequest operations to track the deletion of the 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.

getCluster

Future<GetClusterResponse> getCluster(GetClusterRequest request,
                                      AsyncHandler<GetClusterRequest,GetClusterResponse> handler)

Gets the specified Cluster’s information.

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.

listClusters

Future<ListClustersResponse> listClusters(ListClustersRequest request,
                                          AsyncHandler<ListClustersRequest,ListClustersResponse> handler)

Lists the Clusters in the specified 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.

updateCluster

Future<UpdateClusterResponse> updateCluster(UpdateClusterRequest request,
                                            AsyncHandler<UpdateClusterRequest,UpdateClusterResponse> handler)

Updates the specified Cluster.

*Important:** Updating a Cluster affects only certain attributes in the `Cluster` object and does not affect the VMware environment currently running in the 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.