Package com.oracle.bmc.limits

Interface Limits

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    LimitsClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181025")
public interface Limits
extends AutoCloseable
    APIs that interact with the resource limits of a specific resource type.

    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

      • getResourceAvailability

        GetResourceAvailabilityResponse getResourceAvailability​(GetResourceAvailabilityRequest request)
        For a given compartmentId, resource limit name, and scope, returns the following: * The number of available resources associated with the given limit.
        • The usage in the selected compartment for the given limit. If Subscription Id is provided, then usage for resource created in that subscription will be returned Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.
        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/limits/GetResourceAvailabilityExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetResourceAvailability API.

      • listLimitDefinitions

        ListLimitDefinitionsResponse listLimitDefinitions​(ListLimitDefinitionsRequest request)
        Includes a list of resource limits that are currently supported.

        If subscription Id is provided, then only resource limits supported by subscription will be returned If the ‘areQuotasSupported’ property is true, you can create quota policies on top of this limit at the compartment level.

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

      • listLimitValues

        ListLimitValuesResponse listLimitValues​(ListLimitValuesRequest request)
        Includes a full list of resource limits belonging to a given service.

        If subscription Id is provided, limit value for subscription will be returned.

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

      • listServices

        ListServicesResponse listServices​(ListServicesRequest request)
        Returns the list of supported services.

        If subscription ID is provided then only services supported by subscription will be returned. This includes the programmatic service name, along with the friendly service name.

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

      • getPaginators

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