com.oracle.bmc.ocvp

Class SddcAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.ocvp.SddcAsyncClient

All Implemented Interfaces:

SddcAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public class SddcAsyncClient
extends BaseAsyncClient
implements SddcAsync

Async client implementation for Sddc service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SddcAsyncClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Sddc.

Constructor Summary

Constructors

Constructor and Description
SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static SddcAsyncClient.Builder	builder() Create a builder for this client.
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.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
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)
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	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.ocvp.SddcAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Sddc.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

SddcAsyncClient

@Deprecated
public SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

SddcAsyncClient

@Deprecated
public SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

SddcAsyncClient

@Deprecated
public SddcAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

SddcAsyncClient

@Deprecated
public SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

SddcAsyncClient

@Deprecated
public SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

SddcAsyncClient

@Deprecated
public SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

SddcAsyncClient

@Deprecated
public SddcAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                   ClientConfiguration configuration,
                                   ClientConfigurator clientConfigurator,
                                   RequestSignerFactory defaultRequestSignerFactory,
                                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                   List<ClientConfigurator> additionalClientConfigurators,
                                   String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see SddcAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static SddcAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: SddcAsync

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.

Specified by:

setRegion in interface SddcAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: SddcAsync

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.

Specified by:

setRegion in interface SddcAsync

Parameters:

regionId - The public region ID.

cancelDowngradeHcx

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

Description copied from interface: SddcAsync

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

Specified by:

cancelDowngradeHcx in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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.

Specified by:

changeSddcCompartment in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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.

Specified by:

createSddc in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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.

Specified by:

deleteSddc in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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.

Specified by:

downgradeHcx in interface SddcAsync

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

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

Description copied from interface: SddcAsync

Gets the specified SDDC’s information.

Specified by:

getSddc in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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

Specified by:

listSddcs in interface SddcAsync

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

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

Description copied from interface: SddcAsync

Lists supported Commitments.

Specified by:

listSupportedCommitments in interface SddcAsync

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

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

Description copied from interface: SddcAsync

Lists supported compute shapes for ESXi hosts.

Specified by:

listSupportedHostShapes in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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

Specified by:

listSupportedVmwareSoftwareVersions in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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

Specified by:

refreshHcxLicenseStatus in interface SddcAsync

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

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

Description copied from interface: SddcAsync

Retrieve the SDDC password.

Specified by:

retrievePassword in interface SddcAsync

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

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

Description copied from interface: SddcAsync

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.

Specified by:

updateSddc in interface SddcAsync

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

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

Description copied from interface: SddcAsync

Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.

Specified by:

upgradeHcx in interface SddcAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)