com.oracle.bmc.ocvp

Interface SddcAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

SddcAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public interface SddcAsync
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<CancelDowngradeHcxResponse>	cancelDowngradeHcx(CancelDowngradeHcxRequest request, AsyncHandler<CancelDowngradeHcxRequest,CancelDowngradeHcxResponse> handler) Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.
Future<ChangeSddcCompartmentResponse>	changeSddcCompartment(ChangeSddcCompartmentRequest request, AsyncHandler<ChangeSddcCompartmentRequest,ChangeSddcCompartmentResponse> handler) Moves an SDDC into a different compartment within the same tenancy.
Future<CreateSddcResponse>	createSddc(CreateSddcRequest request, AsyncHandler<CreateSddcRequest,CreateSddcResponse> handler) Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).
Future<DeleteSddcResponse>	deleteSddc(DeleteSddcRequest request, AsyncHandler<DeleteSddcRequest,DeleteSddcResponse> handler) Deletes the specified SDDC, along with the other resources that were created with the SDDC.
Future<DowngradeHcxResponse>	downgradeHcx(DowngradeHcxRequest request, AsyncHandler<DowngradeHcxRequest,DowngradeHcxResponse> handler) Downgrade the specified SDDC from HCX Enterprise to HCX Advanced.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetSddcResponse>	getSddc(GetSddcRequest request, AsyncHandler<GetSddcRequest,GetSddcResponse> handler) Gets the specified SDDC’s information.
Future<ListSddcsResponse>	listSddcs(ListSddcsRequest request, AsyncHandler<ListSddcsRequest,ListSddcsResponse> handler) Lists the SDDCs in the specified compartment.
Future<ListSupportedCommitmentsResponse>	listSupportedCommitments(ListSupportedCommitmentsRequest request, AsyncHandler<ListSupportedCommitmentsRequest,ListSupportedCommitmentsResponse> handler) Lists supported Commitments.
Future<ListSupportedHostShapesResponse>	listSupportedHostShapes(ListSupportedHostShapesRequest request, AsyncHandler<ListSupportedHostShapesRequest,ListSupportedHostShapesResponse> handler) Lists supported compute shapes for ESXi hosts.
Future<ListSupportedVmwareSoftwareVersionsResponse>	listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request, AsyncHandler<ListSupportedVmwareSoftwareVersionsRequest,ListSupportedVmwareSoftwareVersionsResponse> handler) Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
void	refreshClient() Rebuilds the client from scratch.
Future<RefreshHcxLicenseStatusResponse>	refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request, AsyncHandler<RefreshHcxLicenseStatusRequest,RefreshHcxLicenseStatusResponse> handler) Refresh HCX on-premise licenses status of the specified SDDC.
Future<RetrievePasswordResponse>	retrievePassword(RetrievePasswordRequest request, AsyncHandler<RetrievePasswordRequest,RetrievePasswordResponse> handler) Retrieve the SDDC password.
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<UpdateSddcResponse>	updateSddc(UpdateSddcRequest request, AsyncHandler<UpdateSddcRequest,UpdateSddcResponse> handler) Updates the specified SDDC.
Future<UpgradeHcxResponse>	upgradeHcx(UpgradeHcxRequest request, AsyncHandler<UpgradeHcxRequest,UpgradeHcxResponse> handler) Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
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

cancelDowngradeHcx

Future<CancelDowngradeHcxResponse> cancelDowngradeHcx(CancelDowngradeHcxRequest request,
                                                      AsyncHandler<CancelDowngradeHcxRequest,CancelDowngradeHcxResponse> handler)

Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.

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.

changeSddcCompartment

Future<ChangeSddcCompartmentResponse> changeSddcCompartment(ChangeSddcCompartmentRequest request,
                                                            AsyncHandler<ChangeSddcCompartmentRequest,ChangeSddcCompartmentResponse> handler)

Moves an SDDC into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to 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.

createSddc

Future<CreateSddcResponse> createSddc(CreateSddcRequest request,
                                      AsyncHandler<CreateSddcRequest,CreateSddcResponse> handler)

Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).

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

*Important:** You must configure the SDDC'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.

deleteSddc

Future<DeleteSddcResponse> deleteSddc(DeleteSddcRequest request,
                                      AsyncHandler<DeleteSddcRequest,DeleteSddcResponse> handler)

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

Use the WorkRequest operations to track the deletion of the SDDC.

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.

downgradeHcx

Future<DowngradeHcxResponse> downgradeHcx(DowngradeHcxRequest request,
                                          AsyncHandler<DowngradeHcxRequest,DowngradeHcxResponse> handler)

Downgrade the specified SDDC from HCX Enterprise to HCX Advanced. SDDC with standard compute shapes will always use HCX Enterprise if HCX is enabled and cannot be downgraded. Downgrading from HCX Enterprise to HCX Advanced reduces the number of provided license keys from 10 to 3. Downgrade remains in a PENDING state until the end of the current billing cycle. You can use cancelDowngradeHcx to cancel the downgrade while it’s still in a PENDING 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.

getSddc

Future<GetSddcResponse> getSddc(GetSddcRequest request,
                                AsyncHandler<GetSddcRequest,GetSddcResponse> handler)

Gets the specified SDDC’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.

listSddcs

Future<ListSddcsResponse> listSddcs(ListSddcsRequest request,
                                    AsyncHandler<ListSddcsRequest,ListSddcsResponse> handler)

Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.

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.

listSupportedCommitments

Future<ListSupportedCommitmentsResponse> listSupportedCommitments(ListSupportedCommitmentsRequest request,
                                                                  AsyncHandler<ListSupportedCommitmentsRequest,ListSupportedCommitmentsResponse> handler)

Lists supported Commitments.

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.

listSupportedHostShapes

Future<ListSupportedHostShapesResponse> listSupportedHostShapes(ListSupportedHostShapesRequest request,
                                                                AsyncHandler<ListSupportedHostShapesRequest,ListSupportedHostShapesResponse> handler)

Lists supported compute shapes for ESXi hosts.

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.

listSupportedVmwareSoftwareVersions

Future<ListSupportedVmwareSoftwareVersionsResponse> listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request,
                                                                                        AsyncHandler<ListSupportedVmwareSoftwareVersionsRequest,ListSupportedVmwareSoftwareVersionsResponse> handler)

Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.

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.

refreshHcxLicenseStatus

Future<RefreshHcxLicenseStatusResponse> refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request,
                                                                AsyncHandler<RefreshHcxLicenseStatusRequest,RefreshHcxLicenseStatusResponse> handler)

Refresh HCX on-premise licenses status of the specified SDDC.

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.

retrievePassword

Future<RetrievePasswordResponse> retrievePassword(RetrievePasswordRequest request,
                                                  AsyncHandler<RetrievePasswordRequest,RetrievePasswordResponse> handler)

Retrieve the SDDC password.

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.

updateSddc

Future<UpdateSddcResponse> updateSddc(UpdateSddcRequest request,
                                      AsyncHandler<UpdateSddcRequest,UpdateSddcResponse> handler)

Updates the specified SDDC.

*Important:** Updating an SDDC affects only certain attributes in the `Sddc` object and does not affect the VMware environment currently running in the SDDC. For more information, see updateSddcDetails.

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.

upgradeHcx

Future<UpgradeHcxResponse> upgradeHcx(UpgradeHcxRequest request,
                                      AsyncHandler<UpgradeHcxRequest,UpgradeHcxResponse> handler)

Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.

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.