Package com.oracle.bmc.ocvp

Interface ByolAllocation

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    ByolAllocationClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20230701")
public interface ByolAllocation
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

      • changeByolAllocationCompartment

        ChangeByolAllocationCompartmentResponse changeByolAllocationCompartment​(ChangeByolAllocationCompartmentRequest request)
        Moves an BYOL Allocation 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.81.1/ocvp/ChangeByolAllocationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeByolAllocationCompartment API.

      • createByolAllocation

        CreateByolAllocationResponse createByolAllocation​(CreateByolAllocationRequest request)
        Creates an Allocation on an specific Bring-You-Own-License (BYOL).

        Use the WorkRequest operations to track the creation of the BYOL.

        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.81.1/ocvp/CreateByolAllocationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateByolAllocation API.

      • deleteByolAllocation

        DeleteByolAllocationResponse deleteByolAllocation​(DeleteByolAllocationRequest request)
        Deletes the specified BYOL Allocation.
        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.81.1/ocvp/DeleteByolAllocationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteByolAllocation API.

      • getByolAllocation

        GetByolAllocationResponse getByolAllocation​(GetByolAllocationRequest request)
        Gets the specified BYOL Allocation’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.81.1/ocvp/GetByolAllocationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetByolAllocation API.

      • listByolAllocations

        ListByolAllocationsResponse listByolAllocations​(ListByolAllocationsRequest request)
        Lists the BYOL Allocations 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.81.1/ocvp/ListByolAllocationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListByolAllocations API.

      • updateByolAllocation

        UpdateByolAllocationResponse updateByolAllocation​(UpdateByolAllocationRequest request)
        Updates the specified BYOL Allocation.
        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.81.1/ocvp/UpdateByolAllocationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateByolAllocation API.

      • getWaiters

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

      • getPaginators

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