Class SddcClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.ocvp.SddcClient
-
- All Implemented Interfaces:
Sddc
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20230701") public class SddcClient extends BaseSyncClient implements Sddc
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SddcClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field 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 Description SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SddcClient.Builder
builder()
Create a builder for this client.CancelDowngradeHcxResponse
cancelDowngradeHcx(CancelDowngradeHcxRequest request)
Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.ChangeSddcCompartmentResponse
changeSddcCompartment(ChangeSddcCompartmentRequest request)
Moves an SDDC into a different compartment within the same tenancy.void
close()
CreateSddcResponse
createSddc(CreateSddcRequest request)
Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).DeleteSddcResponse
deleteSddc(DeleteSddcRequest request)
Deletes the specified SDDC, along with the other resources that were created with the SDDC.DowngradeHcxResponse
downgradeHcx(DowngradeHcxRequest request)
Downgrade the specified SDDC from HCX Enterprise to HCX Advanced.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
SddcPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetSddcResponse
getSddc(GetSddcRequest request)
Gets the specified SDDC’s information.SddcWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListSddcsResponse
listSddcs(ListSddcsRequest request)
Lists the SDDCs in the specified compartment.ListSupportedCommitmentsResponse
listSupportedCommitments(ListSupportedCommitmentsRequest request)
Lists supported Commitments.ListSupportedHostShapesResponse
listSupportedHostShapes(ListSupportedHostShapesRequest request)
Lists supported compute shapes for ESXi hosts.ListSupportedVmwareSoftwareVersionsResponse
listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)
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 backingHttpClient
.RefreshHcxLicenseStatusResponse
refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request)
Refresh HCX on-premise licenses status of the specified SDDC.RetrievePasswordResponse
retrievePassword(RetrievePasswordRequest request)
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.UpdateSddcResponse
updateSddc(UpdateSddcRequest request)
Updates the specified SDDC.UpgradeHcxResponse
upgradeHcx(UpgradeHcxRequest request)
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 com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.ocvp.Sddc
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
SddcClient
@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
SddcClient
@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
SddcClient
@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
SddcClient
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
SddcClient
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
SddcClient
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.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)
-
SddcClient
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.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
-
SddcClient
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeSddcClient.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
executorService
-SddcClient.Builder.executorService
-
-
Method Detail
-
builder
public static SddcClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:Sddc
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:Sddc
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 callsetEndpoint
.
-
cancelDowngradeHcx
public CancelDowngradeHcxResponse cancelDowngradeHcx(CancelDowngradeHcxRequest request)
Description copied from interface:Sddc
Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.- Specified by:
cancelDowngradeHcx
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeSddcCompartment
public ChangeSddcCompartmentResponse changeSddcCompartment(ChangeSddcCompartmentRequest request)
Description copied from interface:Sddc
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 interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createSddc
public CreateSddcResponse createSddc(CreateSddcRequest request)
Description copied from interface:Sddc
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.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 interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteSddc
public DeleteSddcResponse deleteSddc(DeleteSddcRequest request)
Description copied from interface:Sddc
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 interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
downgradeHcx
public DowngradeHcxResponse downgradeHcx(DowngradeHcxRequest request)
Description copied from interface:Sddc
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 usecancelDowngradeHcx
to cancel the downgrade while it’s still in aPENDING
state.- Specified by:
downgradeHcx
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getSddc
public GetSddcResponse getSddc(GetSddcRequest request)
Description copied from interface:Sddc
Gets the specified SDDC’s information.
-
listSddcs
public ListSddcsResponse listSddcs(ListSddcsRequest request)
Description copied from interface:Sddc
Lists the SDDCs in the specified compartment.The list can be filtered by display name or availability domain.
-
listSupportedCommitments
public ListSupportedCommitmentsResponse listSupportedCommitments(ListSupportedCommitmentsRequest request)
Description copied from interface:Sddc
Lists supported Commitments.- Specified by:
listSupportedCommitments
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSupportedHostShapes
public ListSupportedHostShapesResponse listSupportedHostShapes(ListSupportedHostShapesRequest request)
Description copied from interface:Sddc
Lists supported compute shapes for ESXi hosts.- Specified by:
listSupportedHostShapes
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listSupportedVmwareSoftwareVersions
public ListSupportedVmwareSoftwareVersionsResponse listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)
Description copied from interface:Sddc
Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.- Specified by:
listSupportedVmwareSoftwareVersions
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
refreshHcxLicenseStatus
public RefreshHcxLicenseStatusResponse refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request)
Description copied from interface:Sddc
Refresh HCX on-premise licenses status of the specified SDDC.- Specified by:
refreshHcxLicenseStatus
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
retrievePassword
public RetrievePasswordResponse retrievePassword(RetrievePasswordRequest request)
Description copied from interface:Sddc
Retrieve the SDDC password.- Specified by:
retrievePassword
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateSddc
public UpdateSddcResponse updateSddc(UpdateSddcRequest request)
Description copied from interface:Sddc
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 interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
upgradeHcx
public UpgradeHcxResponse upgradeHcx(UpgradeHcxRequest request)
Description copied from interface:Sddc
Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.- Specified by:
upgradeHcx
in interfaceSddc
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public SddcWaiters getWaiters()
Description copied from interface:Sddc
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceSddc
- Returns:
- The service waiters.
-
getPaginators
public SddcPaginators getPaginators()
Description copied from interface:Sddc
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an
Iterable
interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
getPaginators
in interfaceSddc
- Returns:
- The service paginators.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-