SddcClient (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.ocvp.SddcClient

All Implemented Interfaces:: Sddc, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200501")
public class SddcClient
extends Object
implements Sddc

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SddcClient.Builder
Builder class for this client.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SddcClient.Builder` Builder class for this client.

Field Summary

Fields
Modifier and Type Field and Description

static Service SERVICE
Service instance for Sddc.

Fields
Modifier and Type	Field and Description
`static Service`	`SERVICE` Service instance for Sddc.

Constructor Summary

Constructors
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.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Sddc.
- Constructor Detail
  - SddcClient
```
public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Creates a new service instance using the given authentication provider.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
  - SddcClient
```
public SddcClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                  ClientConfiguration configuration)
```
    Creates a new service instance using the given authentication provider and client configuration.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details provider, required.
    
    configuration - The client configuration, optional.
  - SddcClient
```
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.
    
    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.
  - SddcClient
```
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.
    
    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.
  - SddcClient
```
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.
    
    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.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
  - SddcClient
```
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.
    
    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.
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - SddcClient
```
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.
    
    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 signer
    
    additionalClientConfigurators - Additional client configurators to be run after the primary configurator.
    
    endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)
  - SddcClient
```
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.
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
  - SddcClient
```
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. 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.
    
    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 signer
    
    additionalClientConfigurators - 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 ThreadPoolExecutor
    
    restClientFactoryBuilder - the builder for the RestClientFactory
- Method Detail
  - builder
```
public static SddcClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: Sddc
    
    Sets the endpoint to call (ex, https://www.example.com).
    
    Specified by:
    
    setEndpoint in interface Sddc
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
public String getEndpoint()
```
    Description copied from interface: Sddc
    
    Gets the set endpoint for REST call (ex, https://www.example.com)
    
    Specified by:
    
    getEndpoint in interface Sddc
  - 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.
    
    Specified by:
    
    setRegion in interface Sddc
    
    Parameters:
    
    region - The region of the service.
  - 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 call setEndpoint.
    
    Specified by:
    
    setRegion in interface Sddc
    
    Parameters:
    
    regionId - The public region ID.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - 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 interface Sddc
    
    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 interface Sddc
    
    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.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 Sddc
    
    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 interface Sddc
    
    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. 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 Sddc
    
    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.
    
    Specified by:
    
    getSddc in interface Sddc
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - 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.
    
    Specified by:
    
    listSddcs in interface Sddc
    
    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 interface Sddc
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listSupportedSkus
```
public ListSupportedSkusResponse listSupportedSkus(ListSupportedSkusRequest request)
```
    Description copied from interface: Sddc
    
    Lists supported SKUs.
    
    Specified by:
    
    listSupportedSkus in interface Sddc
    
    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 interface Sddc
    
    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 interface Sddc
    
    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 interface Sddc
    
    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 interface Sddc
    
    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 interface Sddc
    
    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 interface Sddc
    
    Returns:
    
    The service paginators.

Class SddcClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SERVICE

Constructor Detail

SddcClient

SddcClient

SddcClient

SddcClient

SddcClient

SddcClient

SddcClient

SddcClient

SddcClient

Method Detail

builder

setEndpoint

getEndpoint

setRegion

setRegion

close

cancelDowngradeHcx

changeSddcCompartment

createSddc

deleteSddc

downgradeHcx

getSddc

listSddcs

listSupportedHostShapes

listSupportedSkus

listSupportedVmwareSoftwareVersions

refreshHcxLicenseStatus

updateSddc

upgradeHcx

getWaiters

getPaginators