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 SummaryNested Classes Modifier and Type Class Description static classSddcClient.BuilderBuilder class for this client.
 - 
Field SummaryFields Modifier and Type Field Description StringclientCommonLibraryVersionCompatible SDK version, provided by the codegen.Optional<String>minimumClientCommonLibraryVersionFromClientMinimum compatible SDK version, maybe provided by the codegen.static ServiceSERVICEService instance for Sddc.
 - 
Constructor SummaryConstructors Constructor Description SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)Deprecated.Use thebuilderinstead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)Deprecated.Use thebuilderinstead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)Deprecated.Use thebuilderinstead.SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)Deprecated.Use thebuilderinstead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)Deprecated.Use thebuilderinstead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)Deprecated.Use thebuilderinstead.SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)Deprecated.Use thebuilderinstead.
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SddcClient.Builderbuilder()Create a builder for this client.CancelDowngradeHcxResponsecancelDowngradeHcx(CancelDowngradeHcxRequest request)Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.ChangeSddcCompartmentResponsechangeSddcCompartment(ChangeSddcCompartmentRequest request)Moves an SDDC into a different compartment within the same tenancy.voidclose()CreateSddcResponsecreateSddc(CreateSddcRequest request)Creates an Oracle Cloud VMware Solution software-defined data center (SDDC).DeleteSddcResponsedeleteSddc(DeleteSddcRequest request)Deletes the specified SDDC, along with the other resources that were created with the SDDC.DowngradeHcxResponsedowngradeHcx(DowngradeHcxRequest request)Downgrade the specified SDDC from HCX Enterprise to HCX Advanced.StringgetClientCommonLibraryVersion()protected ClientConfiguratorgetDefaultConfigurator()StringgetEndpoint()Optional<String>getMinimumClientCommonLibraryVersionFromClient()SddcPaginatorsgetPaginators()Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetSddcResponsegetSddc(GetSddcRequest request)Gets the specified SDDC’s information.SddcWaitersgetWaiters()Gets the pre-configured waiters available for resources for this service.ListSddcsResponselistSddcs(ListSddcsRequest request)Lists the SDDCs in the specified compartment.ListSupportedCommitmentsResponselistSupportedCommitments(ListSupportedCommitmentsRequest request)Lists supported Commitments.ListSupportedHostShapesResponselistSupportedHostShapes(ListSupportedHostShapesRequest request)Lists supported compute shapes for ESXi hosts.ListSupportedVmwareSoftwareVersionsResponselistSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.voidpopulateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)Populate the parameters in the endpoint with its corresponding value and update the base endpoint.voidrefreshClient()Rebuild the backingHttpClient.RefreshHcxLicenseStatusResponserefreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request)Refresh HCX on-premise licenses status of the specified SDDC.RetrievePasswordResponseretrievePassword(RetrievePasswordRequest request)Retrieve the SDDC password.voidsetEndpoint(String endpoint)voidsetRegion(Region region)Sets the region to call (ex, Region.US_PHOENIX_1).voidsetRegion(String regionId)Sets the region to call (ex, ‘us-phoenix-1’).voidupdateBaseEndpoint(String endpoint)This method should be used for parameterized endpoint templates only.UpdateSddcResponseupdateSddc(UpdateSddcRequest request)Updates the specified SDDC.UpgradeHcxResponseupgradeHcx(UpgradeHcxRequest request)Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.voiduseRealmSpecificEndpointTemplate(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.BaseSyncClientclientCall
 - 
Methods inherited from class java.lang.Objectclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 - 
Methods inherited from interface java.lang.AutoCloseableclose
 - 
Methods inherited from interface com.oracle.bmc.ocvp.SddcgetEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
 
- 
 
- 
- 
- 
Constructor Detail- 
SddcClient@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
 
 - 
SddcClient@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- SddcClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
- configuration-- ClientBuilderBase.configuration
 
 - 
SddcClient@Deprecated public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- authenticationDetailsProvider- The authentication details (see- SddcClient.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 thebuilderinstead.Create a new client instance.- Parameters:
- 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
 
 - 
SddcClient@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- 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
 
 - 
SddcClient@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- 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)
 
 - 
SddcClient@Deprecated public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated.Use thebuilderinstead.Create a new client instance.- Parameters:
- 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
 
 - 
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 thebuilderinstead.Create a new client instance.- Parameters:
- 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
 
 
- 
 - 
Method Detail- 
builderpublic static SddcClient.Builder builder() Create a builder for this client.- Returns:
- builder
 
 - 
setRegionpublic void setRegion(Region region) Description copied from interface:SddcSets the region to call (ex, Region.US_PHOENIX_1).Note, this will call setEndpointafter resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
 - 
setRegionpublic void setRegion(String regionId) Description copied from interface:SddcSets 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.
 - 
cancelDowngradeHcxpublic CancelDowngradeHcxResponse cancelDowngradeHcx(CancelDowngradeHcxRequest request) Description copied from interface:SddcCancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.- Specified by:
- cancelDowngradeHcxin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
changeSddcCompartmentpublic ChangeSddcCompartmentResponse changeSddcCompartment(ChangeSddcCompartmentRequest request) Description copied from interface:SddcMoves 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:
- changeSddcCompartmentin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
createSddcpublic CreateSddcResponse createSddc(CreateSddcRequest request) Description copied from interface:SddcCreates an Oracle Cloud VMware Solution software-defined data center (SDDC).Use the WorkRequestoperations 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:
- createSddcin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
deleteSddcpublic DeleteSddcResponse deleteSddc(DeleteSddcRequest request) Description copied from interface:SddcDeletes 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 WorkRequestoperations to track the deletion of the SDDC.- Specified by:
- deleteSddcin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
downgradeHcxpublic DowngradeHcxResponse downgradeHcx(DowngradeHcxRequest request) Description copied from interface:SddcDowngrade 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 PENDINGstate until the end of the current billing cycle. You can usecancelDowngradeHcxto cancel the downgrade while it’s still in aPENDINGstate.- Specified by:
- downgradeHcxin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getSddcpublic GetSddcResponse getSddc(GetSddcRequest request) Description copied from interface:SddcGets the specified SDDC’s information.
 - 
listSddcspublic ListSddcsResponse listSddcs(ListSddcsRequest request) Description copied from interface:SddcLists the SDDCs in the specified compartment.The list can be filtered by display name or availability domain. 
 - 
listSupportedCommitmentspublic ListSupportedCommitmentsResponse listSupportedCommitments(ListSupportedCommitmentsRequest request) Description copied from interface:SddcLists supported Commitments.- Specified by:
- listSupportedCommitmentsin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listSupportedHostShapespublic ListSupportedHostShapesResponse listSupportedHostShapes(ListSupportedHostShapesRequest request) Description copied from interface:SddcLists supported compute shapes for ESXi hosts.- Specified by:
- listSupportedHostShapesin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
listSupportedVmwareSoftwareVersionspublic ListSupportedVmwareSoftwareVersionsResponse listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request) Description copied from interface:SddcLists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.- Specified by:
- listSupportedVmwareSoftwareVersionsin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
refreshHcxLicenseStatuspublic RefreshHcxLicenseStatusResponse refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request) Description copied from interface:SddcRefresh HCX on-premise licenses status of the specified SDDC.- Specified by:
- refreshHcxLicenseStatusin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
retrievePasswordpublic RetrievePasswordResponse retrievePassword(RetrievePasswordRequest request) Description copied from interface:SddcRetrieve the SDDC password.- Specified by:
- retrievePasswordin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
updateSddcpublic UpdateSddcResponse updateSddc(UpdateSddcRequest request) Description copied from interface:SddcUpdates 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:
- updateSddcin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
upgradeHcxpublic UpgradeHcxResponse upgradeHcx(UpgradeHcxRequest request) Description copied from interface:SddcUpgrade the specified SDDC from HCX Advanced to HCX Enterprise.- Specified by:
- upgradeHcxin interface- Sddc
- Parameters:
- request- The request object containing the details to send
- Returns:
- A response object containing details about the completed operation
 
 - 
getWaiterspublic SddcWaiters getWaiters() Description copied from interface:SddcGets the pre-configured waiters available for resources for this service.- Specified by:
- getWaitersin interface- Sddc
- Returns:
- The service waiters.
 
 - 
getPaginatorspublic SddcPaginators getPaginators() Description copied from interface:SddcGets the pre-configured paginators available for list operations in this service which may return multiple pages of data.These paginators provide an Iterableinterface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.- Specified by:
- getPaginatorsin interface- Sddc
- Returns:
- The service paginators.
 
 - 
getDefaultConfiguratorprotected ClientConfigurator getDefaultConfigurator() 
 - 
useRealmSpecificEndpointTemplatepublic 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
 
 - 
populateServiceParametersInEndpointpublic 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
 
 - 
updateBaseEndpointpublic 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
 
 - 
setEndpointpublic final void setEndpoint(String endpoint) 
 - 
getEndpointpublic final String getEndpoint() 
 - 
refreshClientpublic final void refreshClient() Rebuild the backingHttpClient.This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
 - 
closepublic final void close() - Specified by:
- closein interface- AutoCloseable
 
 - 
getClientCommonLibraryVersionpublic String getClientCommonLibraryVersion() 
 
- 
 
-