@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.
Modifier and Type | Method and 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.
|
close
void refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
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.
region
- The region of the service.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
.
regionId
- The public region ID.AddQuotaLockResponse addQuotaLock(AddQuotaLockRequest request)
Adds a lock to a resource.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use AddQuotaLock API.
CreateQuotaResponse createQuota(CreateQuotaRequest request)
Creates a new quota with the details supplied.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use CreateQuota API.
DeleteQuotaResponse deleteQuota(DeleteQuotaRequest request)
Deletes the quota corresponding to the given OCID.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use DeleteQuota API.
GetQuotaResponse getQuota(GetQuotaRequest request)
Gets the quota for the OCID specified.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use GetQuota API.
ListQuotasResponse listQuotas(ListQuotasRequest request)
Lists all quotas on resources from the given compartment.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use ListQuotas API.
RemoveQuotaLockResponse removeQuotaLock(RemoveQuotaLockRequest request)
Remove a lock from a resource.
request
- The request object containing the details to sendBmcException
- 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_Retries
Example: Click here to see how to use RemoveQuotaLock API.
UpdateQuotaResponse updateQuota(UpdateQuotaRequest request)
Updates the quota corresponding to given OCID with the details supplied.
request
- The request object containing the details to sendBmcException
- 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 here to see how to use UpdateQuota API.
QuotasWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
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.
Copyright © 2016–2023. All rights reserved.