Waa (Oracle Cloud Infrastructure Java SDK

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

WaaClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211230")
public interface Waa
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.

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

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`ChangeWebAppAccelerationCompartmentResponse`	`changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request)` Moves a Web App Acceleration resource from one compartment to another.
`ChangeWebAppAccelerationPolicyCompartmentResponse`	`changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request)` Moves a WebAppAccelerationfPolicy resource from one compartment to another.
`CreateWebAppAccelerationResponse`	`createWebAppAcceleration(CreateWebAppAccelerationRequest request)` Creates a new WebAppAcceleration.
`CreateWebAppAccelerationPolicyResponse`	`createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request)` Creates a new WebAppAccelerationPolicy.
`DeleteWebAppAccelerationResponse`	`deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request)` Deletes a WebAppAcceleration resource identified by the OCID.
`DeleteWebAppAccelerationPolicyResponse`	`deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request)` Deletes a WebAppAccelerationPolicy resource identified by the OCID.
`String`	`getEndpoint()` Gets the set endpoint for REST call (ex, https://www.example.com)
`WaaPaginators`	`getPaginators()` Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`WaaWaiters`	`getWaiters()` Gets the pre-configured waiters available for resources for this service.
`GetWebAppAccelerationResponse`	`getWebAppAcceleration(GetWebAppAccelerationRequest request)` Gets a WebAppAcceleration by OCID.
`GetWebAppAccelerationPolicyResponse`	`getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request)` Gets a WebAppAccelerationPolicy with the given OCID.
`ListWebAppAccelerationPoliciesResponse`	`listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request)` Gets a list of all WebAppAccelerationPolicies in a compartment.
`ListWebAppAccelerationsResponse`	`listWebAppAccelerations(ListWebAppAccelerationsRequest request)` Gets a list of all WebAppAccelerations in a compartment.
`PurgeWebAppAccelerationCacheResponse`	`purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request)` 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’).
`UpdateWebAppAccelerationResponse`	`updateWebAppAcceleration(UpdateWebAppAccelerationRequest request)` Updates the WebAppAcceleration identified by the OCID.
`UpdateWebAppAccelerationPolicyResponse`	`updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request)` 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 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.
  - 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
```
ChangeWebAppAccelerationCompartmentResponse changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request)
```
    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
    
    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 ChangeWebAppAccelerationCompartment API.
  - changeWebAppAccelerationPolicyCompartment
```
ChangeWebAppAccelerationPolicyCompartmentResponse changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request)
```
    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
    
    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 ChangeWebAppAccelerationPolicyCompartment API.
  - createWebAppAcceleration
```
CreateWebAppAccelerationResponse createWebAppAcceleration(CreateWebAppAccelerationRequest request)
```
    Creates a new WebAppAcceleration.
    
    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 CreateWebAppAcceleration API.
  - createWebAppAccelerationPolicy
```
CreateWebAppAccelerationPolicyResponse createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request)
```
    Creates a new WebAppAccelerationPolicy.
    
    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 CreateWebAppAccelerationPolicy API.
  - deleteWebAppAcceleration
```
DeleteWebAppAccelerationResponse deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request)
```
    Deletes a WebAppAcceleration resource identified by the OCID.
    
    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 DeleteWebAppAcceleration API.
  - deleteWebAppAccelerationPolicy
```
DeleteWebAppAccelerationPolicyResponse deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request)
```
    Deletes a WebAppAccelerationPolicy resource identified by the OCID.
    
    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 DeleteWebAppAccelerationPolicy API.
  - getWebAppAcceleration
```
GetWebAppAccelerationResponse getWebAppAcceleration(GetWebAppAccelerationRequest request)
```
    Gets a WebAppAcceleration by OCID.
    
    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 GetWebAppAcceleration API.
  - getWebAppAccelerationPolicy
```
GetWebAppAccelerationPolicyResponse getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request)
```
    Gets a WebAppAccelerationPolicy with the given OCID.
    
    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 GetWebAppAccelerationPolicy API.
  - listWebAppAccelerationPolicies
```
ListWebAppAccelerationPoliciesResponse listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request)
```
    Gets a list of all WebAppAccelerationPolicies in a compartment.
    
    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 ListWebAppAccelerationPolicies API.
  - listWebAppAccelerations
```
ListWebAppAccelerationsResponse listWebAppAccelerations(ListWebAppAccelerationsRequest request)
```
    Gets a list of all WebAppAccelerations in a compartment.
    
    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 ListWebAppAccelerations API.
  - purgeWebAppAccelerationCache
```
PurgeWebAppAccelerationCacheResponse purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request)
```
    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
    
    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 PurgeWebAppAccelerationCache API.
  - updateWebAppAcceleration
```
UpdateWebAppAccelerationResponse updateWebAppAcceleration(UpdateWebAppAccelerationRequest request)
```
    Updates the WebAppAcceleration identified by the OCID.
    
    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 UpdateWebAppAcceleration API.
  - updateWebAppAccelerationPolicy
```
UpdateWebAppAccelerationPolicyResponse updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request)
```
    Update the WebAppAccelerationPolicy identified by the OCID.
    
    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 UpdateWebAppAccelerationPolicy API.
  - getWaiters
```
WaaWaiters getWaiters()
```
    Gets the pre-configured waiters available for resources for this service.
    
    Returns:
    
    The service waiters.
  - getPaginators
```
WaaPaginators 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.

Interface Waa

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

changeWebAppAccelerationCompartment

changeWebAppAccelerationPolicyCompartment

createWebAppAcceleration

createWebAppAccelerationPolicy

deleteWebAppAcceleration

deleteWebAppAccelerationPolicy

getWebAppAcceleration

getWebAppAccelerationPolicy

listWebAppAccelerationPolicies

listWebAppAccelerations

purgeWebAppAccelerationCache

updateWebAppAcceleration

updateWebAppAccelerationPolicy

getWaiters

getPaginators