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

Class Predicate

java.lang.Object

software.amazon.awssdk.services.waf.model.Predicate

All Implemented Interfaces:

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

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

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.

Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Predicate.Builder

Method Summary

Modifier and Type	Method	Description
static Predicate.Builder	builder()
String	dataId()	A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	negated()	Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet.
List<SdkField<?>>	sdkFields()
static Class<? extends Predicate.Builder>	serializableBuilderClass()
Predicate.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PredicateType	type()	The type of predicate in a Rule, such as ByteMatch or IPSet.
String	typeAsString()	The type of predicate in a Rule, such as ByteMatch or IPSet.

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

negated

public final Boolean negated()

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

Returns:

Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

type

public final PredicateType type()

The type of predicate in a Rule, such as ByteMatch or IPSet.

If the service returns an enum value that is not available in the current SDK version, type will return PredicateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of predicate in a Rule, such as ByteMatch or IPSet.

See Also:

PredicateType

typeAsString

public final String typeAsString()

The type of predicate in a Rule, such as ByteMatch or IPSet.

If the service returns an enum value that is not available in the current SDK version, type will return PredicateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of predicate in a Rule, such as ByteMatch or IPSet.

See Also:

PredicateType

dataId

public final String dataId()

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Returns:

A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

toBuilder

public Predicate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Predicate.Builder,Predicate>

builder

public static Predicate.Builder builder()

serializableBuilderClass

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