Package software.amazon.awssdk.services.wafv2.model

Class CustomHTTPHeader

java.lang.Object

software.amazon.awssdk.services.wafv2.model.CustomHTTPHeader

All Implemented Interfaces:

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

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

A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CustomHTTPHeader.Builder

Method Summary

Modifier and Type	Method	Description
static CustomHTTPHeader.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	name()	The name of the custom header.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends CustomHTTPHeader.Builder>	serializableBuilderClass()
CustomHTTPHeader.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.
final String	value()	The value of the custom header.

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 Details

name

public final String name()

The name of the custom header.

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

Returns:

The name of the custom header.

For custom request header insertion, when WAF inserts the header into the request, it prefixes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, WAF inserts the header x-amzn-waf-sample.

value

public final String value()

The value of the custom header.

Returns:

The value of the custom header.

toBuilder

public CustomHTTPHeader.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CustomHTTPHeader.Builder,CustomHTTPHeader>

builder

public static CustomHTTPHeader.Builder builder()

serializableBuilderClass

public static Class<? extends CustomHTTPHeader.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo