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

Class HeaderMatchPattern

java.lang.Object

software.amazon.awssdk.services.wafv2.model.HeaderMatchPattern

All Implemented Interfaces:

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

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

The filter to use to identify the subset of headers to inspect in a web request.

You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders.

Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HeaderMatchPattern.Builder

Method Summary

Modifier and Type	Method	Description
All	all()	Inspect all headers.
static HeaderMatchPattern.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<String>	excludedHeaders()	Inspect only the headers whose keys don't match any of the strings specified here.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExcludedHeaders()	For responses, this returns true if the service returned a value for the ExcludedHeaders property.
int	hashCode()
boolean	hasIncludedHeaders()	For responses, this returns true if the service returned a value for the IncludedHeaders property.
List<String>	includedHeaders()	Inspect only the headers that have a key that matches one of the strings specified here.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HeaderMatchPattern.Builder>	serializableBuilderClass()
HeaderMatchPattern.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

all

public final All all()

Inspect all headers.

Returns:

Inspect all headers.

hasIncludedHeaders

public final boolean hasIncludedHeaders()

For responses, this returns true if the service returned a value for the IncludedHeaders 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.

includedHeaders

public final List<String> includedHeaders()

Inspect only the headers that have a key that matches one of the strings specified here.

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 hasIncludedHeaders() method.

Returns:

Inspect only the headers that have a key that matches one of the strings specified here.

hasExcludedHeaders

public final boolean hasExcludedHeaders()

For responses, this returns true if the service returned a value for the ExcludedHeaders 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.

excludedHeaders

public final List<String> excludedHeaders()

Inspect only the headers whose keys don't match any of the strings specified here.

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 hasExcludedHeaders() method.

Returns:

Inspect only the headers whose keys don't match any of the strings specified here.

toBuilder

public HeaderMatchPattern.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HeaderMatchPattern.Builder,HeaderMatchPattern>

builder

public static HeaderMatchPattern.Builder builder()

serializableBuilderClass

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