Package com.oracle.bmc.ocvp

Interface ManagementApplianceAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ManagementApplianceAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public interface ManagementApplianceAsync
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	Description
Future<CreateManagementApplianceResponse>	createManagementAppliance(CreateManagementApplianceRequest request, AsyncHandler<CreateManagementApplianceRequest,CreateManagementApplianceResponse> handler)	Creates a management appliance.
Future<DeleteManagementApplianceResponse>	deleteManagementAppliance(DeleteManagementApplianceRequest request, AsyncHandler<DeleteManagementApplianceRequest,DeleteManagementApplianceResponse> handler)	Deletes management appliance specified.
String	getEndpoint()	Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetManagementApplianceResponse>	getManagementAppliance(GetManagementApplianceRequest request, AsyncHandler<GetManagementApplianceRequest,GetManagementApplianceResponse> handler)	Get the specified management appliance information.
Future<ListManagementAppliancesResponse>	listManagementAppliances(ListManagementAppliancesRequest request, AsyncHandler<ListManagementAppliancesRequest,ListManagementAppliancesResponse> handler)	Lists management appliances in compartment specified.
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<UpdateManagementApplianceResponse>	updateManagementAppliance(UpdateManagementApplianceRequest request, AsyncHandler<UpdateManagementApplianceRequest,UpdateManagementApplianceResponse> handler)	Updates management appliance specified.
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

createManagementAppliance

Future<CreateManagementApplianceResponse> createManagementAppliance(CreateManagementApplianceRequest request,
                                                                    AsyncHandler<CreateManagementApplianceRequest,CreateManagementApplianceResponse> handler)

Creates a management appliance.

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.

deleteManagementAppliance

Future<DeleteManagementApplianceResponse> deleteManagementAppliance(DeleteManagementApplianceRequest request,
                                                                    AsyncHandler<DeleteManagementApplianceRequest,DeleteManagementApplianceResponse> handler)

Deletes management appliance specified.

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.

getManagementAppliance

Future<GetManagementApplianceResponse> getManagementAppliance(GetManagementApplianceRequest request,
                                                              AsyncHandler<GetManagementApplianceRequest,GetManagementApplianceResponse> handler)

Get the specified management appliance 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.

listManagementAppliances

Future<ListManagementAppliancesResponse> listManagementAppliances(ListManagementAppliancesRequest request,
                                                                  AsyncHandler<ListManagementAppliancesRequest,ListManagementAppliancesResponse> handler)

Lists management appliances in compartment specified.

List can be filtered by management appliance, compartment, name and lifecycle state.

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.

updateManagementAppliance

Future<UpdateManagementApplianceResponse> updateManagementAppliance(UpdateManagementApplianceRequest request,
                                                                    AsyncHandler<UpdateManagementApplianceRequest,UpdateManagementApplianceResponse> handler)

Updates management appliance specified.

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.