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

Class RateLimitHeader

java.lang.Object

software.amazon.awssdk.services.wafv2.model.RateLimitHeader

All Implemented Interfaces:

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

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

Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RateLimitHeader.Builder

Method Summary

Modifier and Type	Method	Description
static RateLimitHeader.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTextTransformations()	For responses, this returns true if the service returned a value for the TextTransformations property.
String	name()	The name of the header to use.
List<SdkField<?>>	sdkFields()
static Class<? extends RateLimitHeader.Builder>	serializableBuilderClass()
List<TextTransformation>	textTransformations()	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
RateLimitHeader.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

name

public final String name()

The name of the header to use.

Returns:

The name of the header to use.

hasTextTransformations

public final boolean hasTextTransformations()

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

textTransformations

public final List<TextTransformation> textTransformations()

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

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

Returns:

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.

toBuilder

public RateLimitHeader.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RateLimitHeader.Builder,RateLimitHeader>

builder

public static RateLimitHeader.Builder builder()

serializableBuilderClass

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