com.oracle.bmc.apigateway

Interface UsagePlansAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

UsagePlansAsyncClient

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

API for the API Gateway service. Use this API to manage gateways, deployments, and related items. For more information, see Overview of API Gateway.

Method Summary

Modifier and Type	Method and Description
Future<ChangeUsagePlanCompartmentResponse>	changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request, AsyncHandler<ChangeUsagePlanCompartmentRequest,ChangeUsagePlanCompartmentResponse> handler) Changes the usage plan compartment.
Future<CreateUsagePlanResponse>	createUsagePlan(CreateUsagePlanRequest request, AsyncHandler<CreateUsagePlanRequest,CreateUsagePlanResponse> handler) Creates a new usage plan.
Future<DeleteUsagePlanResponse>	deleteUsagePlan(DeleteUsagePlanRequest request, AsyncHandler<DeleteUsagePlanRequest,DeleteUsagePlanResponse> handler) Deletes the usage plan with the given identifier.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetUsagePlanResponse>	getUsagePlan(GetUsagePlanRequest request, AsyncHandler<GetUsagePlanRequest,GetUsagePlanResponse> handler) Gets a usage plan by identifier.
Future<ListUsagePlansResponse>	listUsagePlans(ListUsagePlansRequest request, AsyncHandler<ListUsagePlansRequest,ListUsagePlansResponse> handler) Returns a list of usage plans.
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’).
Future<UpdateUsagePlanResponse>	updateUsagePlan(UpdateUsagePlanRequest request, AsyncHandler<UpdateUsagePlanRequest,UpdateUsagePlanResponse> handler) Updates the usage plan with the given identifier.
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

changeUsagePlanCompartment

Future<ChangeUsagePlanCompartmentResponse> changeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request,
                                                                      AsyncHandler<ChangeUsagePlanCompartmentRequest,ChangeUsagePlanCompartmentResponse> handler)

Changes the usage plan 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.

createUsagePlan

Future<CreateUsagePlanResponse> createUsagePlan(CreateUsagePlanRequest request,
                                                AsyncHandler<CreateUsagePlanRequest,CreateUsagePlanResponse> handler)

Creates a new usage plan.

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.

deleteUsagePlan

Future<DeleteUsagePlanResponse> deleteUsagePlan(DeleteUsagePlanRequest request,
                                                AsyncHandler<DeleteUsagePlanRequest,DeleteUsagePlanResponse> handler)

Deletes the usage plan with the given identifier.

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.

getUsagePlan

Future<GetUsagePlanResponse> getUsagePlan(GetUsagePlanRequest request,
                                          AsyncHandler<GetUsagePlanRequest,GetUsagePlanResponse> handler)

Gets a usage plan by identifier.

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.

listUsagePlans

Future<ListUsagePlansResponse> listUsagePlans(ListUsagePlansRequest request,
                                              AsyncHandler<ListUsagePlansRequest,ListUsagePlansResponse> handler)

Returns a list of usage plans.

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.

updateUsagePlan

Future<UpdateUsagePlanResponse> updateUsagePlan(UpdateUsagePlanRequest request,
                                                AsyncHandler<UpdateUsagePlanRequest,UpdateUsagePlanResponse> handler)

Updates the usage plan with the given identifier.

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.