com.oracle.bmc.limits

Interface QuotasAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

QuotasAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181025")
public interface QuotasAsync
extends AutoCloseable

APIs that interact with the resource limits of a specific resource type.

Method Summary

Modifier and Type	Method and Description
Future<AddQuotaLockResponse>	addQuotaLock(AddQuotaLockRequest request, AsyncHandler<AddQuotaLockRequest,AddQuotaLockResponse> handler) Adds a lock to a resource.
Future<CreateQuotaResponse>	createQuota(CreateQuotaRequest request, AsyncHandler<CreateQuotaRequest,CreateQuotaResponse> handler) Creates a new quota with the details supplied.
Future<DeleteQuotaResponse>	deleteQuota(DeleteQuotaRequest request, AsyncHandler<DeleteQuotaRequest,DeleteQuotaResponse> handler) Deletes the quota corresponding to the given OCID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetQuotaResponse>	getQuota(GetQuotaRequest request, AsyncHandler<GetQuotaRequest,GetQuotaResponse> handler) Gets the quota for the OCID specified.
Future<ListQuotasResponse>	listQuotas(ListQuotasRequest request, AsyncHandler<ListQuotasRequest,ListQuotasResponse> handler) Lists all quotas on resources from the given compartment.
void	refreshClient() Rebuilds the client from scratch.
Future<RemoveQuotaLockResponse>	removeQuotaLock(RemoveQuotaLockRequest request, AsyncHandler<RemoveQuotaLockRequest,RemoveQuotaLockResponse> handler) 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’).
Future<UpdateQuotaResponse>	updateQuota(UpdateQuotaRequest request, AsyncHandler<UpdateQuotaRequest,UpdateQuotaResponse> handler) 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 serice.

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

addQuotaLock

Future<AddQuotaLockResponse> addQuotaLock(AddQuotaLockRequest request,
                                          AsyncHandler<AddQuotaLockRequest,AddQuotaLockResponse> handler)

Adds a lock to a resource.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

createQuota

Future<CreateQuotaResponse> createQuota(CreateQuotaRequest request,
                                        AsyncHandler<CreateQuotaRequest,CreateQuotaResponse> handler)

Creates a new quota with the details supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

deleteQuota

Future<DeleteQuotaResponse> deleteQuota(DeleteQuotaRequest request,
                                        AsyncHandler<DeleteQuotaRequest,DeleteQuotaResponse> handler)

Deletes the quota corresponding to the given OCID.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getQuota

Future<GetQuotaResponse> getQuota(GetQuotaRequest request,
                                  AsyncHandler<GetQuotaRequest,GetQuotaResponse> handler)

Gets the quota for the OCID specified.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listQuotas

Future<ListQuotasResponse> listQuotas(ListQuotasRequest request,
                                      AsyncHandler<ListQuotasRequest,ListQuotasResponse> handler)

Lists all quotas on resources from the given compartment.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

removeQuotaLock

Future<RemoveQuotaLockResponse> removeQuotaLock(RemoveQuotaLockRequest request,
                                                AsyncHandler<RemoveQuotaLockRequest,RemoveQuotaLockResponse> handler)

Remove a lock from a resource.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateQuota

Future<UpdateQuotaResponse> updateQuota(UpdateQuotaRequest request,
                                        AsyncHandler<UpdateQuotaRequest,UpdateQuotaResponse> handler)

Updates the quota corresponding to given OCID with the details supplied.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.