software.amazon.awssdk.services.wafv2.model

Class CustomRequestHandling

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CustomRequestHandling

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CustomRequestHandling.Builder,CustomRequestHandling>

@Generated(value="software.amazon.awssdk:codegen")
public final class CustomRequestHandling
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CustomRequestHandling.Builder,CustomRequestHandling>

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for WAF to use when the rule action doesn't block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CustomRequestHandling.Builder

Method Summary

Modifier and Type	Method and Description
static CustomRequestHandling.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInsertHeaders() For responses, this returns true if the service returned a value for the InsertHeaders property.
List<CustomHTTPHeader>	insertHeaders() The HTTP headers to insert into the request.
List<SdkField<?>>	sdkFields()
static Class<? extends CustomRequestHandling.Builder>	serializableBuilderClass()
CustomRequestHandling.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasInsertHeaders

public final boolean hasInsertHeaders()

For responses, this returns true if the service returned a value for the InsertHeaders property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

insertHeaders

public final List<CustomHTTPHeader> insertHeaders()

The HTTP headers to insert into the request. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsertHeaders() method.

Returns:

The HTTP headers to insert into the request. Duplicate header names are not allowed.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

toBuilder

public CustomRequestHandling.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomRequestHandling.Builder,CustomRequestHandling>

builder

public static CustomRequestHandling.Builder builder()

serializableBuilderClass

public static Class<? extends CustomRequestHandling.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo