Package software.amazon.awssdk.services.waf.model

Class SizeConstraintSet

java.lang.Object

software.amazon.awssdk.services.waf.model.SizeConstraintSet

All Implemented Interfaces:

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

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

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SizeConstraintSet.Builder

Method Summary

Modifier and Type	Method	Description
static SizeConstraintSet.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSizeConstraints()	For responses, this returns true if the service returned a value for the SizeConstraints property.
String	name()	The name, if any, of the SizeConstraintSet.
List<SdkField<?>>	sdkFields()
static Class<? extends SizeConstraintSet.Builder>	serializableBuilderClass()
List<SizeConstraint>	sizeConstraints()	Specifies the parts of web requests that you want to inspect the size of.
String	sizeConstraintSetId()	A unique identifier for a SizeConstraintSet.
SizeConstraintSet.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

sizeConstraintSetId

public final String sizeConstraintSetId()

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

Returns:

A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

name

public final String name()

The name, if any, of the SizeConstraintSet.

Returns:

The name, if any, of the SizeConstraintSet.

hasSizeConstraints

public final boolean hasSizeConstraints()

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

sizeConstraints

public final List<SizeConstraint> sizeConstraints()

Specifies the parts of web requests that you want to inspect the size of.

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

Returns:

Specifies the parts of web requests that you want to inspect the size of.

toBuilder

public SizeConstraintSet.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SizeConstraintSet.Builder,SizeConstraintSet>

builder

public static SizeConstraintSet.Builder builder()

serializableBuilderClass

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