Package com.oracle.bmc.ocvp

Interface Sddc

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    SddcClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public interface Sddc
extends AutoCloseable
    Use the Oracle Cloud VMware API to create SDDCs and manage ESXi hosts and software.

    For more information, see Oracle Cloud VMware Solution.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        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.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        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.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • cancelDowngradeHcx

        CancelDowngradeHcxResponse cancelDowngradeHcx​(CancelDowngradeHcxRequest request)
        Cancel the pending SDDC downgrade from HCX Enterprise to HCX Advanced.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/CancelDowngradeHcxExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelDowngradeHcx API.

      • changeSddcCompartment

        ChangeSddcCompartmentResponse changeSddcCompartment​(ChangeSddcCompartmentRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/ChangeSddcCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeSddcCompartment API.

      • createSddc

        CreateSddcResponse createSddc​(CreateSddcRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/CreateSddcExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSddc API.

      • deleteSddc

        DeleteSddcResponse deleteSddc​(DeleteSddcRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/DeleteSddcExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSddc API.

      • downgradeHcx

        DowngradeHcxResponse downgradeHcx​(DowngradeHcxRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/DowngradeHcxExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DowngradeHcx API.

      • getSddc

        GetSddcResponse getSddc​(GetSddcRequest request)
        Gets the specified SDDC’s information.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/GetSddcExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSddc API.

      • listSddcs

        ListSddcsResponse listSddcs​(ListSddcsRequest request)
        Lists the SDDCs in the specified compartment.

        The list can be filtered by display name or availability domain.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/ListSddcsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSddcs API.

      • listSupportedCommitments

        ListSupportedCommitmentsResponse listSupportedCommitments​(ListSupportedCommitmentsRequest request)
        Lists supported Commitments.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/ListSupportedCommitmentsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedCommitments API.

      • listSupportedHostShapes

        ListSupportedHostShapesResponse listSupportedHostShapes​(ListSupportedHostShapesRequest request)
        Lists supported compute shapes for ESXi hosts.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/ListSupportedHostShapesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedHostShapes API.

      • listSupportedVmwareSoftwareVersions

        ListSupportedVmwareSoftwareVersionsResponse listSupportedVmwareSoftwareVersions​(ListSupportedVmwareSoftwareVersionsRequest request)
        Lists the versions of bundled VMware software supported by the Oracle Cloud VMware Solution.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/ListSupportedVmwareSoftwareVersionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSupportedVmwareSoftwareVersions API.

      • refreshHcxLicenseStatus

        RefreshHcxLicenseStatusResponse refreshHcxLicenseStatus​(RefreshHcxLicenseStatusRequest request)
        Refresh HCX on-premise licenses status of the specified SDDC.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/RefreshHcxLicenseStatusExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RefreshHcxLicenseStatus API.

      • retrievePassword

        RetrievePasswordResponse retrievePassword​(RetrievePasswordRequest request)
        Retrieve the SDDC password.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/RetrievePasswordExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RetrievePassword API.

      • updateSddc

        UpdateSddcResponse updateSddc​(UpdateSddcRequest request)
        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.

        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/UpdateSddcExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSddc API.

      • upgradeHcx

        UpgradeHcxResponse upgradeHcx​(UpgradeHcxRequest request)
        Upgrade the specified SDDC from HCX Advanced to HCX Enterprise.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/ocvp/UpgradeHcxExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpgradeHcx API.

      • getWaiters

        SddcWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        SddcPaginators getPaginators()
        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.

        Returns:
        The service paginators.