@Generated(value="OracleSDKGenerator", comments="API Version: 20230701") public class SddcClient extends BaseSyncClient implements Sddc
Modifier and Type | Class and Description |
---|---|
static class |
SddcClient.Builder
Builder class for this client.
|
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 and Description |
---|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
Modifier and Type | Method and 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 backing
HttpClient . |
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.
|
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for Sddc.
public final String clientCommonLibraryVersion
@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.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)
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.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
@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see SddcClient.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
public static SddcClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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 call setEndpoint
.
public CancelDowngradeHcxResponse cancelDowngradeHcx(CancelDowngradeHcxRequest request)
Sddc
Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.
cancelDowngradeHcx
in interface Sddc
request
- The request object containing the details to sendpublic ChangeSddcCompartmentResponse changeSddcCompartment(ChangeSddcCompartmentRequest request)
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.
changeSddcCompartment
in interface Sddc
request
- The request object containing the details to sendpublic CreateSddcResponse createSddc(CreateSddcRequest request)
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.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.
createSddc
in interface Sddc
request
- The request object containing the details to sendpublic DeleteSddcResponse deleteSddc(DeleteSddcRequest request)
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.
deleteSddc
in interface Sddc
request
- The request object containing the details to sendpublic DowngradeHcxResponse downgradeHcx(DowngradeHcxRequest request)
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
use cancelDowngradeHcx
to cancel the
downgrade while it’s still in a PENDING
state.
downgradeHcx
in interface Sddc
request
- The request object containing the details to sendpublic GetSddcResponse getSddc(GetSddcRequest request)
Sddc
Gets the specified SDDC’s information.
public ListSddcsResponse listSddcs(ListSddcsRequest request)
Sddc
Lists the SDDCs in the specified compartment. The list can be filtered by display name or availability domain.
public ListSupportedCommitmentsResponse listSupportedCommitments(ListSupportedCommitmentsRequest request)
Sddc
Lists supported Commitments.
listSupportedCommitments
in interface Sddc
request
- The request object containing the details to sendpublic ListSupportedHostShapesResponse listSupportedHostShapes(ListSupportedHostShapesRequest request)
Sddc
Lists supported compute shapes for ESXi hosts.
listSupportedHostShapes
in interface Sddc
request
- The request object containing the details to sendpublic ListSupportedVmwareSoftwareVersionsResponse listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)
Sddc
Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
listSupportedVmwareSoftwareVersions
in interface Sddc
request
- The request object containing the details to sendpublic RefreshHcxLicenseStatusResponse refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request)
Sddc
Refresh HCX on-premise licenses status of the specified SDDC.
refreshHcxLicenseStatus
in interface Sddc
request
- The request object containing the details to sendpublic RetrievePasswordResponse retrievePassword(RetrievePasswordRequest request)
Sddc
Retrieve the SDDC password.
retrievePassword
in interface Sddc
request
- The request object containing the details to sendpublic UpdateSddcResponse updateSddc(UpdateSddcRequest request)
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
.
updateSddc
in interface Sddc
request
- The request object containing the details to sendpublic UpgradeHcxResponse upgradeHcx(UpgradeHcxRequest request)
Sddc
Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
upgradeHcx
in interface Sddc
request
- The request object containing the details to sendpublic SddcWaiters getWaiters()
Sddc
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface Sddc
public SddcPaginators getPaginators()
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.
getPaginators
in interface Sddc
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.