Package com.oracle.bmc.limitsincrease

Interface LimitsIncrease

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    LimitsIncreaseClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20251101")
public interface LimitsIncrease
extends AutoCloseable
    Use the Limits Increase API to work with limit increase requests.

    For more information, see Working with Limit Increase Requests.

    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

      • cancelLimitsIncreaseItemRequest

        CancelLimitsIncreaseItemRequestResponse cancelLimitsIncreaseItemRequest​(CancelLimitsIncreaseItemRequestRequest request)
        Withdraws the specified item from the limit increase request.

        For more information, see Withdrawing an Item from a Limit Increase Request.

        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/limitsincrease/CancelLimitsIncreaseItemRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelLimitsIncreaseItemRequest API.

      • cancelLimitsIncreaseRequest

        CancelLimitsIncreaseRequestResponse cancelLimitsIncreaseRequest​(CancelLimitsIncreaseRequestRequest request)
        Withdraws the specified limit increase request.

        For more information, see Withdrawing a Limit Increase Request.

        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/limitsincrease/CancelLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CancelLimitsIncreaseRequest API.

      • createLimitsIncreaseRequest

        CreateLimitsIncreaseRequestResponse createLimitsIncreaseRequest​(CreateLimitsIncreaseRequestRequest request)
        Creates a limit increase request in the specified compartment.

        For more information, see Creating a Limit Increase Request.

        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/limitsincrease/CreateLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateLimitsIncreaseRequest API.

      • deleteLimitsIncreaseRequest

        DeleteLimitsIncreaseRequestResponse deleteLimitsIncreaseRequest​(DeleteLimitsIncreaseRequestRequest request)
        Deletes the specified limit increase request.

        For more information, see Deleting a Limit Increase Request.

        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/limitsincrease/DeleteLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteLimitsIncreaseRequest API.

      • getLimitsIncreaseItemRequest

        GetLimitsIncreaseItemRequestResponse getLimitsIncreaseItemRequest​(GetLimitsIncreaseItemRequestRequest request)
        Gets the specified item from the limit increase request.

        For more information, see Getting Details for a Limit Increase Request.

        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/limitsincrease/GetLimitsIncreaseItemRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLimitsIncreaseItemRequest API.

      • getLimitsIncreaseRequest

        GetLimitsIncreaseRequestResponse getLimitsIncreaseRequest​(GetLimitsIncreaseRequestRequest request)
        Gets the specified limit increase request.

        For more information, see Getting Details for a Limit Increase Request.

        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/limitsincrease/GetLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetLimitsIncreaseRequest API.

      • listLimitsIncreaseItemRequests

        ListLimitsIncreaseItemRequestsResponse listLimitsIncreaseItemRequests​(ListLimitsIncreaseItemRequestsRequest request)
        Lists items in the specified limit increase request.

        For more information, see Getting Details for a Limit Increase Request.

        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/limitsincrease/ListLimitsIncreaseItemRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLimitsIncreaseItemRequests API.

      • listLimitsIncreaseQuestions

        ListLimitsIncreaseQuestionsResponse listLimitsIncreaseQuestions​(ListLimitsIncreaseQuestionsRequest request)
        Gets the fields for the specified service and limit name.

        Service name is required if limit name is provided. If limit name is not provided, returns all questions for the specified service. If service name is not provided, returns all available questions. For more information, see Creating a Limit Increase Request.

        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/limitsincrease/ListLimitsIncreaseQuestionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLimitsIncreaseQuestions API.

      • listLimitsIncreaseRequests

        ListLimitsIncreaseRequestsResponse listLimitsIncreaseRequests​(ListLimitsIncreaseRequestsRequest request)
        Lists limit increase requests in the specified compartment.

        For more information, see Listing Limit Increase Requests.

        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/limitsincrease/ListLimitsIncreaseRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListLimitsIncreaseRequests API.

      • patchLimitsIncreaseRequest

        PatchLimitsIncreaseRequestResponse patchLimitsIncreaseRequest​(PatchLimitsIncreaseRequestRequest request)
        Adds one or more comments to the specified limit increase request.

        For more information, see Adding Comments to a Limit Increase Request.

        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/limitsincrease/PatchLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PatchLimitsIncreaseRequest API.

      • updateLimitsIncreaseRequest

        UpdateLimitsIncreaseRequestResponse updateLimitsIncreaseRequest​(UpdateLimitsIncreaseRequestRequest request)
        Updates the limit increase request.

        For more information, see Updating a Limit Increase Request.

        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/limitsincrease/UpdateLimitsIncreaseRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateLimitsIncreaseRequest API.

      • getWaiters

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

      • getPaginators

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