Interface Quotas
-
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
QuotasClient
@Generated(value="OracleSDKGenerator", comments="API Version: 20181025") public interface Quotas 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 Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description AddQuotaLockResponse
addQuotaLock(AddQuotaLockRequest request)
Adds a lock to a resource.CreateQuotaResponse
createQuota(CreateQuotaRequest request)
Creates a new quota with the details supplied.DeleteQuotaResponse
deleteQuota(DeleteQuotaRequest request)
Deletes the quota corresponding to the given OCID.String
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)QuotasPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.GetQuotaResponse
getQuota(GetQuotaRequest request)
Gets the quota for the OCID specified.QuotasWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ListQuotasResponse
listQuotas(ListQuotasRequest request)
Lists all quotas on resources from the given compartment.void
refreshClient()
Rebuilds the client from scratch.RemoveQuotaLockResponse
removeQuotaLock(RemoveQuotaLockRequest request)
Remove a lock from a resource.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’).UpdateQuotaResponse
updateQuota(UpdateQuotaRequest request)
Updates the quota corresponding to given OCID with the details supplied.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
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 callsetEndpoint
.- 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
-
addQuotaLock
AddQuotaLockResponse addQuotaLock(AddQuotaLockRequest request)
Adds a lock to a resource.- 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/AddQuotaLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use AddQuotaLock API.
-
createQuota
CreateQuotaResponse createQuota(CreateQuotaRequest request)
Creates a new quota with the details supplied.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/CreateQuotaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateQuota API.
-
deleteQuota
DeleteQuotaResponse deleteQuota(DeleteQuotaRequest request)
Deletes the quota corresponding to the given OCID.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/DeleteQuotaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteQuota API.
-
getQuota
GetQuotaResponse getQuota(GetQuotaRequest request)
Gets the quota for the OCID specified.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/GetQuotaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetQuota API.
-
listQuotas
ListQuotasResponse listQuotas(ListQuotasRequest request)
Lists all quotas on resources from the given 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/ListQuotasExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListQuotas API.
-
removeQuotaLock
RemoveQuotaLockResponse removeQuotaLock(RemoveQuotaLockRequest request)
Remove a lock from a resource.- 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 will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/RemoveQuotaLockExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use RemoveQuotaLock API.
-
updateQuota
UpdateQuotaResponse updateQuota(UpdateQuotaRequest request)
Updates the quota corresponding to given OCID with the details supplied.- 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_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/limits/UpdateQuotaExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateQuota API.
-
getWaiters
QuotasWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.- Returns:
- The service waiters.
-
getPaginators
QuotasPaginators 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.
-
-