com.oracle.bmc.waa

Interface WaaAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

WaaAsyncClient

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

API for the Web Application Acceleration service. Use this API to manage regional Web App Acceleration policies such as Caching and Compression for accelerating HTTP services.

Method Summary

Modifier and Type	Method and Description
Future<ChangeWebAppAccelerationCompartmentResponse>	changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request, AsyncHandler<ChangeWebAppAccelerationCompartmentRequest,ChangeWebAppAccelerationCompartmentResponse> handler) Moves a Web App Acceleration resource from one compartment to another.
Future<ChangeWebAppAccelerationPolicyCompartmentResponse>	changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request, AsyncHandler<ChangeWebAppAccelerationPolicyCompartmentRequest,ChangeWebAppAccelerationPolicyCompartmentResponse> handler) Moves a WebAppAccelerationfPolicy resource from one compartment to another.
Future<CreateWebAppAccelerationResponse>	createWebAppAcceleration(CreateWebAppAccelerationRequest request, AsyncHandler<CreateWebAppAccelerationRequest,CreateWebAppAccelerationResponse> handler) Creates a new WebAppAcceleration.
Future<CreateWebAppAccelerationPolicyResponse>	createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request, AsyncHandler<CreateWebAppAccelerationPolicyRequest,CreateWebAppAccelerationPolicyResponse> handler) Creates a new WebAppAccelerationPolicy.
Future<DeleteWebAppAccelerationResponse>	deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request, AsyncHandler<DeleteWebAppAccelerationRequest,DeleteWebAppAccelerationResponse> handler) Deletes a WebAppAcceleration resource identified by the OCID.
Future<DeleteWebAppAccelerationPolicyResponse>	deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request, AsyncHandler<DeleteWebAppAccelerationPolicyRequest,DeleteWebAppAccelerationPolicyResponse> handler) Deletes a WebAppAccelerationPolicy resource identified by the OCID.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetWebAppAccelerationResponse>	getWebAppAcceleration(GetWebAppAccelerationRequest request, AsyncHandler<GetWebAppAccelerationRequest,GetWebAppAccelerationResponse> handler) Gets a WebAppAcceleration by OCID.
Future<GetWebAppAccelerationPolicyResponse>	getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request, AsyncHandler<GetWebAppAccelerationPolicyRequest,GetWebAppAccelerationPolicyResponse> handler) Gets a WebAppAccelerationPolicy with the given OCID.
Future<ListWebAppAccelerationPoliciesResponse>	listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request, AsyncHandler<ListWebAppAccelerationPoliciesRequest,ListWebAppAccelerationPoliciesResponse> handler) Gets a list of all WebAppAccelerationPolicies in a compartment.
Future<ListWebAppAccelerationsResponse>	listWebAppAccelerations(ListWebAppAccelerationsRequest request, AsyncHandler<ListWebAppAccelerationsRequest,ListWebAppAccelerationsResponse> handler) Gets a list of all WebAppAccelerations in a compartment.
Future<PurgeWebAppAccelerationCacheResponse>	purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request, AsyncHandler<PurgeWebAppAccelerationCacheRequest,PurgeWebAppAccelerationCacheResponse> handler) Clears resources from the cache of the WebAppAcceleration.
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<UpdateWebAppAccelerationResponse>	updateWebAppAcceleration(UpdateWebAppAccelerationRequest request, AsyncHandler<UpdateWebAppAccelerationRequest,UpdateWebAppAccelerationResponse> handler) Updates the WebAppAcceleration identified by the OCID.
Future<UpdateWebAppAccelerationPolicyResponse>	updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request, AsyncHandler<UpdateWebAppAccelerationPolicyRequest,UpdateWebAppAccelerationPolicyResponse> handler) Update the WebAppAccelerationPolicy identified by the OCID.
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

changeWebAppAccelerationCompartment

Future<ChangeWebAppAccelerationCompartmentResponse> changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request,
                                                                                        AsyncHandler<ChangeWebAppAccelerationCompartmentRequest,ChangeWebAppAccelerationCompartmentResponse> handler)

Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the 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.

changeWebAppAccelerationPolicyCompartment

Future<ChangeWebAppAccelerationPolicyCompartmentResponse> changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request,
                                                                                                    AsyncHandler<ChangeWebAppAccelerationPolicyCompartmentRequest,ChangeWebAppAccelerationPolicyCompartmentResponse> handler)

Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the 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.

createWebAppAcceleration

Future<CreateWebAppAccelerationResponse> createWebAppAcceleration(CreateWebAppAccelerationRequest request,
                                                                  AsyncHandler<CreateWebAppAccelerationRequest,CreateWebAppAccelerationResponse> handler)

Creates a new WebAppAcceleration.

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.

createWebAppAccelerationPolicy

Future<CreateWebAppAccelerationPolicyResponse> createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request,
                                                                              AsyncHandler<CreateWebAppAccelerationPolicyRequest,CreateWebAppAccelerationPolicyResponse> handler)

Creates a new WebAppAccelerationPolicy.

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.

deleteWebAppAcceleration

Future<DeleteWebAppAccelerationResponse> deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request,
                                                                  AsyncHandler<DeleteWebAppAccelerationRequest,DeleteWebAppAccelerationResponse> handler)

Deletes a WebAppAcceleration resource identified by the 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.

deleteWebAppAccelerationPolicy

Future<DeleteWebAppAccelerationPolicyResponse> deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request,
                                                                              AsyncHandler<DeleteWebAppAccelerationPolicyRequest,DeleteWebAppAccelerationPolicyResponse> handler)

Deletes a WebAppAccelerationPolicy resource identified by the 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.

getWebAppAcceleration

Future<GetWebAppAccelerationResponse> getWebAppAcceleration(GetWebAppAccelerationRequest request,
                                                            AsyncHandler<GetWebAppAccelerationRequest,GetWebAppAccelerationResponse> handler)

Gets a WebAppAcceleration by 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.

getWebAppAccelerationPolicy

Future<GetWebAppAccelerationPolicyResponse> getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request,
                                                                        AsyncHandler<GetWebAppAccelerationPolicyRequest,GetWebAppAccelerationPolicyResponse> handler)

Gets a WebAppAccelerationPolicy with 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.

listWebAppAccelerationPolicies

Future<ListWebAppAccelerationPoliciesResponse> listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request,
                                                                              AsyncHandler<ListWebAppAccelerationPoliciesRequest,ListWebAppAccelerationPoliciesResponse> handler)

Gets a list of all WebAppAccelerationPolicies in a 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.

listWebAppAccelerations

Future<ListWebAppAccelerationsResponse> listWebAppAccelerations(ListWebAppAccelerationsRequest request,
                                                                AsyncHandler<ListWebAppAccelerationsRequest,ListWebAppAccelerationsResponse> handler)

Gets a list of all WebAppAccelerations in a 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.

purgeWebAppAccelerationCache

Future<PurgeWebAppAccelerationCacheResponse> purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request,
                                                                          AsyncHandler<PurgeWebAppAccelerationCacheRequest,PurgeWebAppAccelerationCacheResponse> handler)

Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the 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.

updateWebAppAcceleration

Future<UpdateWebAppAccelerationResponse> updateWebAppAcceleration(UpdateWebAppAccelerationRequest request,
                                                                  AsyncHandler<UpdateWebAppAccelerationRequest,UpdateWebAppAccelerationResponse> handler)

Updates the WebAppAcceleration identified by the 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.

updateWebAppAccelerationPolicy

Future<UpdateWebAppAccelerationPolicyResponse> updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request,
                                                                              AsyncHandler<UpdateWebAppAccelerationPolicyRequest,UpdateWebAppAccelerationPolicyResponse> handler)

Update the WebAppAccelerationPolicy identified by the 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.