com.oracle.bmc.waf

Class WafClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.waf.WafClient

All Implemented Interfaces:

Waf, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210930")
public class WafClient
extends BaseSyncClient
implements Waf

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for Waf.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static WafClient.Builder	builder() Create a builder for this client.
ChangeNetworkAddressListCompartmentResponse	changeNetworkAddressListCompartment(ChangeNetworkAddressListCompartmentRequest request) Moves a NetworkAddressList resource from one compartment to another.
ChangeWebAppFirewallCompartmentResponse	changeWebAppFirewallCompartment(ChangeWebAppFirewallCompartmentRequest request) Moves a Web App Firewall resource from one compartment to another.
ChangeWebAppFirewallPolicyCompartmentResponse	changeWebAppFirewallPolicyCompartment(ChangeWebAppFirewallPolicyCompartmentRequest request) Moves a WebAppFirewallfPolicy resource from one compartment to another.
void	close()
CreateNetworkAddressListResponse	createNetworkAddressList(CreateNetworkAddressListRequest request) Creates a new NetworkAddressList.
CreateWebAppFirewallResponse	createWebAppFirewall(CreateWebAppFirewallRequest request) Creates a new WebAppFirewall.
CreateWebAppFirewallPolicyResponse	createWebAppFirewallPolicy(CreateWebAppFirewallPolicyRequest request) Creates a new WebAppFirewallPolicy.
DeleteNetworkAddressListResponse	deleteNetworkAddressList(DeleteNetworkAddressListRequest request) Deletes a NetworkAddressList resource identified by the OCID.
DeleteWebAppFirewallResponse	deleteWebAppFirewall(DeleteWebAppFirewallRequest request) Deletes a WebAppFirewall resource identified by the OCID.
DeleteWebAppFirewallPolicyResponse	deleteWebAppFirewallPolicy(DeleteWebAppFirewallPolicyRequest request) Deletes a WebAppFirewallPolicy resource identified by the OCID.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
GetNetworkAddressListResponse	getNetworkAddressList(GetNetworkAddressListRequest request) Gets a NetworkAddressList by OCID.
WafPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
WafWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWebAppFirewallResponse	getWebAppFirewall(GetWebAppFirewallRequest request) Gets a WebAppFirewall by OCID.
GetWebAppFirewallPolicyResponse	getWebAppFirewallPolicy(GetWebAppFirewallPolicyRequest request) Gets a WebAppFirewallPolicy with the given OCID.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the WorkRequest with the given OCID.
ListNetworkAddressListsResponse	listNetworkAddressLists(ListNetworkAddressListsRequest request) Gets a list of all NetworkAddressLists in a compartment.
ListProtectionCapabilitiesResponse	listProtectionCapabilities(ListProtectionCapabilitiesRequest request) Lists of protection capabilities filtered by query parameters.
ListProtectionCapabilityGroupTagsResponse	listProtectionCapabilityGroupTags(ListProtectionCapabilityGroupTagsRequest request) Lists of available group tags filtered by query parameters.
ListWebAppFirewallPoliciesResponse	listWebAppFirewallPolicies(ListWebAppFirewallPoliciesRequest request) Gets a list of all WebAppFirewallPolicies in a compartment.
ListWebAppFirewallsResponse	listWebAppFirewalls(ListWebAppFirewallsRequest request) Gets a list of all WebAppFirewalls in a compartment.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a (paginated) list of errors for a given WorkRequest.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a (paginated) list of logs for a given WorkRequest.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the WorkRequests 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.
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.
UpdateNetworkAddressListResponse	updateNetworkAddressList(UpdateNetworkAddressListRequest request) Update the NetworkAddressList identified by the OCID.
UpdateWebAppFirewallResponse	updateWebAppFirewall(UpdateWebAppFirewallRequest request) Updates the WebAppFirewall identified by the OCID.
UpdateWebAppFirewallPolicyResponse	updateWebAppFirewallPolicy(UpdateWebAppFirewallPolicyRequest request) Update the WebAppFirewallPolicy 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.waf.Waf

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Waf.

Constructor Detail

WafClient

@Deprecated
public WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

WafClient

@Deprecated
public WafClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                             ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

WafClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

WafClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

WafClient

@Deprecated
public WafClient(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 WafClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

WafClient

@Deprecated
public WafClient(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 WafClient.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)

WafClient

@Deprecated
public WafClient(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 WafClient.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

WafClient

@Deprecated
public WafClient(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 WafClient.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 - WafClient.Builder.executorService

Method Detail

builder

public static WafClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Waf

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 Waf

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Waf

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 Waf

Parameters:

regionId - The public region ID.

changeNetworkAddressListCompartment

public ChangeNetworkAddressListCompartmentResponse changeNetworkAddressListCompartment(ChangeNetworkAddressListCompartmentRequest request)

Description copied from interface: Waf

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

Specified by:

changeNetworkAddressListCompartment in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeWebAppFirewallCompartment

public ChangeWebAppFirewallCompartmentResponse changeWebAppFirewallCompartment(ChangeWebAppFirewallCompartmentRequest request)

Description copied from interface: Waf

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

Specified by:

changeWebAppFirewallCompartment in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeWebAppFirewallPolicyCompartment

public ChangeWebAppFirewallPolicyCompartmentResponse changeWebAppFirewallPolicyCompartment(ChangeWebAppFirewallPolicyCompartmentRequest request)

Description copied from interface: Waf

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

Specified by:

changeWebAppFirewallPolicyCompartment in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createNetworkAddressList

public CreateNetworkAddressListResponse createNetworkAddressList(CreateNetworkAddressListRequest request)

Description copied from interface: Waf

Creates a new NetworkAddressList.

Specified by:

createNetworkAddressList in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createWebAppFirewall

public CreateWebAppFirewallResponse createWebAppFirewall(CreateWebAppFirewallRequest request)

Description copied from interface: Waf

Creates a new WebAppFirewall.

Specified by:

createWebAppFirewall in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createWebAppFirewallPolicy

public CreateWebAppFirewallPolicyResponse createWebAppFirewallPolicy(CreateWebAppFirewallPolicyRequest request)

Description copied from interface: Waf

Creates a new WebAppFirewallPolicy.

Specified by:

createWebAppFirewallPolicy in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteNetworkAddressList

public DeleteNetworkAddressListResponse deleteNetworkAddressList(DeleteNetworkAddressListRequest request)

Description copied from interface: Waf

Deletes a NetworkAddressList resource identified by the OCID.

Specified by:

deleteNetworkAddressList in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWebAppFirewall

public DeleteWebAppFirewallResponse deleteWebAppFirewall(DeleteWebAppFirewallRequest request)

Description copied from interface: Waf

Deletes a WebAppFirewall resource identified by the OCID.

Specified by:

deleteWebAppFirewall in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteWebAppFirewallPolicy

public DeleteWebAppFirewallPolicyResponse deleteWebAppFirewallPolicy(DeleteWebAppFirewallPolicyRequest request)

Description copied from interface: Waf

Deletes a WebAppFirewallPolicy resource identified by the OCID.

Specified by:

deleteWebAppFirewallPolicy in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getNetworkAddressList

public GetNetworkAddressListResponse getNetworkAddressList(GetNetworkAddressListRequest request)

Description copied from interface: Waf

Gets a NetworkAddressList by OCID.

Specified by:

getNetworkAddressList in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWebAppFirewall

public GetWebAppFirewallResponse getWebAppFirewall(GetWebAppFirewallRequest request)

Description copied from interface: Waf

Gets a WebAppFirewall by OCID.

Specified by:

getWebAppFirewall in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWebAppFirewallPolicy

public GetWebAppFirewallPolicyResponse getWebAppFirewallPolicy(GetWebAppFirewallPolicyRequest request)

Description copied from interface: Waf

Gets a WebAppFirewallPolicy with the given OCID.

Specified by:

getWebAppFirewallPolicy in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: Waf

Gets the status of the WorkRequest with the given OCID.

Specified by:

getWorkRequest in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listNetworkAddressLists

public ListNetworkAddressListsResponse listNetworkAddressLists(ListNetworkAddressListsRequest request)

Description copied from interface: Waf

Gets a list of all NetworkAddressLists in a compartment.

Specified by:

listNetworkAddressLists in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProtectionCapabilities

public ListProtectionCapabilitiesResponse listProtectionCapabilities(ListProtectionCapabilitiesRequest request)

Description copied from interface: Waf

Lists of protection capabilities filtered by query parameters.

Specified by:

listProtectionCapabilities in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listProtectionCapabilityGroupTags

public ListProtectionCapabilityGroupTagsResponse listProtectionCapabilityGroupTags(ListProtectionCapabilityGroupTagsRequest request)

Description copied from interface: Waf

Lists of available group tags filtered by query parameters.

Specified by:

listProtectionCapabilityGroupTags in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWebAppFirewallPolicies

public ListWebAppFirewallPoliciesResponse listWebAppFirewallPolicies(ListWebAppFirewallPoliciesRequest request)

Description copied from interface: Waf

Gets a list of all WebAppFirewallPolicies in a compartment.

Specified by:

listWebAppFirewallPolicies in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWebAppFirewalls

public ListWebAppFirewallsResponse listWebAppFirewalls(ListWebAppFirewallsRequest request)

Description copied from interface: Waf

Gets a list of all WebAppFirewalls in a compartment.

Specified by:

listWebAppFirewalls in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: Waf

Return a (paginated) list of errors for a given WorkRequest.

Specified by:

listWorkRequestErrors in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: Waf

Return a (paginated) list of logs for a given WorkRequest.

Specified by:

listWorkRequestLogs in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: Waf

Lists the WorkRequests in a compartment.

Specified by:

listWorkRequests in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateNetworkAddressList

public UpdateNetworkAddressListResponse updateNetworkAddressList(UpdateNetworkAddressListRequest request)

Description copied from interface: Waf

Update the NetworkAddressList identified by the OCID.

Specified by:

updateNetworkAddressList in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateWebAppFirewall

public UpdateWebAppFirewallResponse updateWebAppFirewall(UpdateWebAppFirewallRequest request)

Description copied from interface: Waf

Updates the WebAppFirewall identified by the OCID.

Specified by:

updateWebAppFirewall in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateWebAppFirewallPolicy

public UpdateWebAppFirewallPolicyResponse updateWebAppFirewallPolicy(UpdateWebAppFirewallPolicyRequest request)

Description copied from interface: Waf

Update the WebAppFirewallPolicy identified by the OCID.

Specified by:

updateWebAppFirewallPolicy in interface Waf

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public WafWaiters getWaiters()

Description copied from interface: Waf

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

Specified by:

getWaiters in interface Waf

Returns:

The service waiters.

getPaginators

public WafPaginators getPaginators()

Description copied from interface: Waf

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 Waf

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