com.oracle.bmc.waa

Class WaaClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.waa.WaaClient

All Implemented Interfaces:

Waa, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20211230")
public class WaaClient
extends BaseSyncClient
implements Waa

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WaaClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Waa.

Constructor Summary

Constructors

Constructor and Description
WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static WaaClient.Builder	builder() Create a builder for this client.
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.
void	close()
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	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
PurgeWebAppAccelerationCacheResponse	purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request) Clears resources from the cache of the WebAppAcceleration.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
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 useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.waa.Waa

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Waa.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

WaaClient

@Deprecated
public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

WaaClient

@Deprecated
public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

WaaClient

@Deprecated
public WaaClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

WaaClient

@Deprecated
public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

WaaClient

@Deprecated
public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

WaaClient

@Deprecated
public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

WaaClient

@Deprecated
public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

WaaClient

@Deprecated
public WaaClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration,
                             ClientConfigurator clientConfigurator,
                             RequestSignerFactory defaultRequestSignerFactory,
                             Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                             List<ClientConfigurator> additionalClientConfigurators,
                             String endpoint,
                             ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see WaaClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - WaaClient.Builder.executorService

Method Detail

builder

public static WaaClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Waa

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.

Specified by:

setRegion in interface Waa

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Waa

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.

Specified by:

setRegion in interface Waa

Parameters:

regionId - The public region ID.

changeWebAppAccelerationCompartment

public ChangeWebAppAccelerationCompartmentResponse changeWebAppAccelerationCompartment(ChangeWebAppAccelerationCompartmentRequest request)

Description copied from interface: Waa

Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeWebAppAccelerationCompartment in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeWebAppAccelerationPolicyCompartment

public ChangeWebAppAccelerationPolicyCompartmentResponse changeWebAppAccelerationPolicyCompartment(ChangeWebAppAccelerationPolicyCompartmentRequest request)

Description copied from interface: Waa

Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeWebAppAccelerationPolicyCompartment in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createWebAppAcceleration

public CreateWebAppAccelerationResponse createWebAppAcceleration(CreateWebAppAccelerationRequest request)

Description copied from interface: Waa

Creates a new WebAppAcceleration.

Specified by:

createWebAppAcceleration in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createWebAppAccelerationPolicy

public CreateWebAppAccelerationPolicyResponse createWebAppAccelerationPolicy(CreateWebAppAccelerationPolicyRequest request)

Description copied from interface: Waa

Creates a new WebAppAccelerationPolicy.

Specified by:

createWebAppAccelerationPolicy in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWebAppAcceleration

public DeleteWebAppAccelerationResponse deleteWebAppAcceleration(DeleteWebAppAccelerationRequest request)

Description copied from interface: Waa

Deletes a WebAppAcceleration resource identified by the OCID.

Specified by:

deleteWebAppAcceleration in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWebAppAccelerationPolicy

public DeleteWebAppAccelerationPolicyResponse deleteWebAppAccelerationPolicy(DeleteWebAppAccelerationPolicyRequest request)

Description copied from interface: Waa

Deletes a WebAppAccelerationPolicy resource identified by the OCID.

Specified by:

deleteWebAppAccelerationPolicy in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWebAppAcceleration

public GetWebAppAccelerationResponse getWebAppAcceleration(GetWebAppAccelerationRequest request)

Description copied from interface: Waa

Gets a WebAppAcceleration by OCID.

Specified by:

getWebAppAcceleration in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWebAppAccelerationPolicy

public GetWebAppAccelerationPolicyResponse getWebAppAccelerationPolicy(GetWebAppAccelerationPolicyRequest request)

Description copied from interface: Waa

Gets a WebAppAccelerationPolicy with the given OCID.

Specified by:

getWebAppAccelerationPolicy in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWebAppAccelerationPolicies

public ListWebAppAccelerationPoliciesResponse listWebAppAccelerationPolicies(ListWebAppAccelerationPoliciesRequest request)

Description copied from interface: Waa

Gets a list of all WebAppAccelerationPolicies in a compartment.

Specified by:

listWebAppAccelerationPolicies in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWebAppAccelerations

public ListWebAppAccelerationsResponse listWebAppAccelerations(ListWebAppAccelerationsRequest request)

Description copied from interface: Waa

Gets a list of all WebAppAccelerations in a compartment.

Specified by:

listWebAppAccelerations in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

purgeWebAppAccelerationCache

public PurgeWebAppAccelerationCacheResponse purgeWebAppAccelerationCache(PurgeWebAppAccelerationCacheRequest request)

Description copied from interface: Waa

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.

Specified by:

purgeWebAppAccelerationCache in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateWebAppAcceleration

public UpdateWebAppAccelerationResponse updateWebAppAcceleration(UpdateWebAppAccelerationRequest request)

Description copied from interface: Waa

Updates the WebAppAcceleration identified by the OCID.

Specified by:

updateWebAppAcceleration in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateWebAppAccelerationPolicy

public UpdateWebAppAccelerationPolicyResponse updateWebAppAccelerationPolicy(UpdateWebAppAccelerationPolicyRequest request)

Description copied from interface: Waa

Update the WebAppAccelerationPolicy identified by the OCID.

Specified by:

updateWebAppAccelerationPolicy in interface Waa

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public WaaWaiters getWaiters()

Description copied from interface: Waa

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

Specified by:

getWaiters in interface Waa

Returns:

The service waiters.

getPaginators

public WaaPaginators getPaginators()

Description copied from interface: Waa

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.

Specified by:

getPaginators in interface Waa

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()