@Generated(value="OracleSDKGenerator", comments="API Version: 20200501") public class SddcClient extends Object implements Sddc
Modifier and Type | Class and Description |
---|---|
static class |
SddcClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for Sddc.
|
Modifier | Constructor and Description |
---|---|
|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
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 |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
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.
|
ListSupportedHostShapesResponse |
listSupportedHostShapes(ListSupportedHostShapesRequest request)
Lists supported compute shapes for ESXi hosts.
|
ListSupportedSkusResponse |
listSupportedSkus(ListSupportedSkusRequest request)
Lists supported SKUs.
|
ListSupportedVmwareSoftwareVersionsResponse |
listSupportedVmwareSoftwareVersions(ListSupportedVmwareSoftwareVersionsRequest request)
Lists the versions of bundled VMware software supported by the Oracle Cloud
VMware Solution.
|
RefreshHcxLicenseStatusResponse |
refreshHcxLicenseStatus(RefreshHcxLicenseStatusRequest request)
Refresh HCX on-premise licenses status of the specified SDDC.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
UpdateSddcResponse |
updateSddc(UpdateSddcRequest request)
Updates the specified SDDC.
|
UpgradeHcxResponse |
upgradeHcx(UpgradeHcxRequest request)
Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
|
public static final Service SERVICE
Service instance for Sddc.
public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected SddcClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the SddcClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static SddcClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
Sddc
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface Sddc
endpoint
- The endpoint of the service.public String getEndpoint()
Sddc
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface Sddc
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 void close()
close
in interface AutoCloseable
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.
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 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 ListSupportedSkusResponse listSupportedSkus(ListSupportedSkusRequest request)
Sddc
Lists supported SKUs.
listSupportedSkus
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 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
Copyright © 2016–2022. All rights reserved.