com.oracle.bmc.waas

Interface Redirect

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

RedirectClient

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

OCI Web Application Acceleration and Security Services This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

Modifier and Type	Method and Description
ChangeHttpRedirectCompartmentResponse	changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request) Moves HTTP Redirect into a different compartment.
CreateHttpRedirectResponse	createHttpRedirect(CreateHttpRedirectRequest request) Creates a new HTTP Redirect on the WAF edge.
DeleteHttpRedirectResponse	deleteHttpRedirect(DeleteHttpRedirectRequest request) Deletes a redirect.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetHttpRedirectResponse	getHttpRedirect(GetHttpRedirectRequest request) Gets the details of a HTTP Redirect.
RedirectPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
RedirectWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListHttpRedirectsResponse	listHttpRedirects(ListHttpRedirectsRequest request) Gets a list of HTTP Redirects.
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’).
UpdateHttpRedirectResponse	updateHttpRedirect(UpdateHttpRedirectRequest request) Updates the details of a HTTP Redirect, including target and tags.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

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.

changeHttpRedirectCompartment

ChangeHttpRedirectCompartmentResponse changeHttpRedirectCompartment(ChangeHttpRedirectCompartmentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ChangeHttpRedirectCompartment API.

createHttpRedirect

CreateHttpRedirectResponse createHttpRedirect(CreateHttpRedirectRequest request)

Creates a new HTTP Redirect on the WAF edge.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use CreateHttpRedirect API.

deleteHttpRedirect

DeleteHttpRedirectResponse deleteHttpRedirect(DeleteHttpRedirectRequest request)

Deletes a redirect.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use DeleteHttpRedirect API.

getHttpRedirect

GetHttpRedirectResponse getHttpRedirect(GetHttpRedirectRequest request)

Gets the details of a HTTP Redirect.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use GetHttpRedirect API.

listHttpRedirects

ListHttpRedirectsResponse listHttpRedirects(ListHttpRedirectsRequest request)

Gets a list of HTTP Redirects.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use ListHttpRedirects API.

updateHttpRedirect

UpdateHttpRedirectResponse updateHttpRedirect(UpdateHttpRedirectRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

Example: Click here to see how to use UpdateHttpRedirect API.

getWaiters

RedirectWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

RedirectPaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.