com.oracle.bmc.waas

Interface RedirectAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RedirectAsyncClient

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

OCI Web Application Acceleration and Security Services

Method Summary

Modifier and Type	Method and Description
Future<ChangeHttpRedirectCompartmentResponse>	changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request, AsyncHandler<ChangeHttpRedirectCompartmentRequest,ChangeHttpRedirectCompartmentResponse> handler) Moves HTTP Redirect into a different compartment.
Future<CreateHttpRedirectResponse>	createHttpRedirect(CreateHttpRedirectRequest request, AsyncHandler<CreateHttpRedirectRequest,CreateHttpRedirectResponse> handler) Creates a new HTTP Redirect on the WAF edge.
Future<DeleteHttpRedirectResponse>	deleteHttpRedirect(DeleteHttpRedirectRequest request, AsyncHandler<DeleteHttpRedirectRequest,DeleteHttpRedirectResponse> handler) Deletes a redirect.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetHttpRedirectResponse>	getHttpRedirect(GetHttpRedirectRequest request, AsyncHandler<GetHttpRedirectRequest,GetHttpRedirectResponse> handler) Gets the details of a HTTP Redirect.
Future<ListHttpRedirectsResponse>	listHttpRedirects(ListHttpRedirectsRequest request, AsyncHandler<ListHttpRedirectsRequest,ListHttpRedirectsResponse> handler) Gets a list of HTTP Redirects.
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<UpdateHttpRedirectResponse>	updateHttpRedirect(UpdateHttpRedirectRequest request, AsyncHandler<UpdateHttpRedirectRequest,UpdateHttpRedirectResponse> handler) Updates the details of a HTTP Redirect, including target and tags.
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

changeHttpRedirectCompartment

Future<ChangeHttpRedirectCompartmentResponse> changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request,
                                                                            AsyncHandler<ChangeHttpRedirectCompartmentRequest,ChangeHttpRedirectCompartmentResponse> handler)

Moves HTTP Redirect into a different compartment. When provided, If-Match is checked against ETag values of the WAAS policy.

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.

createHttpRedirect

Future<CreateHttpRedirectResponse> createHttpRedirect(CreateHttpRedirectRequest request,
                                                      AsyncHandler<CreateHttpRedirectRequest,CreateHttpRedirectResponse> handler)

Creates a new HTTP Redirect on the WAF edge.

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.

deleteHttpRedirect

Future<DeleteHttpRedirectResponse> deleteHttpRedirect(DeleteHttpRedirectRequest request,
                                                      AsyncHandler<DeleteHttpRedirectRequest,DeleteHttpRedirectResponse> handler)

Deletes a redirect.

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.

getHttpRedirect

Future<GetHttpRedirectResponse> getHttpRedirect(GetHttpRedirectRequest request,
                                                AsyncHandler<GetHttpRedirectRequest,GetHttpRedirectResponse> handler)

Gets the details of a HTTP Redirect.

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.

listHttpRedirects

Future<ListHttpRedirectsResponse> listHttpRedirects(ListHttpRedirectsRequest request,
                                                    AsyncHandler<ListHttpRedirectsRequest,ListHttpRedirectsResponse> handler)

Gets a list of HTTP Redirects.

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.

updateHttpRedirect

Future<UpdateHttpRedirectResponse> updateHttpRedirect(UpdateHttpRedirectRequest request,
                                                      AsyncHandler<UpdateHttpRedirectRequest,UpdateHttpRedirectResponse> handler)

Updates the details of a HTTP Redirect, including target and tags. Only the fields specified in the request body will be updated; all other properties will remain unchanged.

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.