com.oracle.bmc.limits

Interface LimitsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LimitsAsyncClient

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

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

Method Summary

Modifier and Type	Method and Description
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetResourceAvailabilityResponse>	getResourceAvailability(GetResourceAvailabilityRequest request, AsyncHandler<GetResourceAvailabilityRequest,GetResourceAvailabilityResponse> handler) For a given compartmentId, resource limit name, and scope, returns the following: * The number of available resources associated with the given limit.
Future<ListLimitDefinitionsResponse>	listLimitDefinitions(ListLimitDefinitionsRequest request, AsyncHandler<ListLimitDefinitionsRequest,ListLimitDefinitionsResponse> handler) Includes a list of resource limits that are currently supported.
Future<ListLimitValuesResponse>	listLimitValues(ListLimitValuesRequest request, AsyncHandler<ListLimitValuesRequest,ListLimitValuesResponse> handler) Includes a full list of resource limits belonging to a given service.
Future<ListServicesResponse>	listServices(ListServicesRequest request, AsyncHandler<ListServicesRequest,ListServicesResponse> handler) Returns the list of supported services.
void	refreshClient() Rebuilds the client from scratch.
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’).
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

getResourceAvailability

Future<GetResourceAvailabilityResponse> getResourceAvailability(GetResourceAvailabilityRequest request,
                                                                AsyncHandler<GetResourceAvailabilityRequest,GetResourceAvailabilityResponse> handler)

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

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.

listLimitDefinitions

Future<ListLimitDefinitionsResponse> listLimitDefinitions(ListLimitDefinitionsRequest request,
                                                          AsyncHandler<ListLimitDefinitionsRequest,ListLimitDefinitionsResponse> handler)

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

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.

listLimitValues

Future<ListLimitValuesResponse> listLimitValues(ListLimitValuesRequest request,
                                                AsyncHandler<ListLimitValuesRequest,ListLimitValuesResponse> handler)

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

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.

listServices

Future<ListServicesResponse> listServices(ListServicesRequest request,
                                          AsyncHandler<ListServicesRequest,ListServicesResponse> handler)

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

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.