software.amazon.awssdk.services.waf.model

Class Predicate

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Predicate.Builder,Predicate>

@Generated(value="software.amazon.awssdk:codegen")
public class Predicate
extends Object
implements StructuredPojo, ToCopyableBuilder<Predicate.Builder,Predicate>

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Predicate.Builder

Method Summary

Modifier and Type	Method and 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
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.
static Class<? extends Predicate.Builder>	serializableBuilderClass()
Predicate.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
PredicateType	type() The type of predicate in a Rule, such as ByteMatchSet or IPSet.
String	typeAsString() The type of predicate in a Rule, such as ByteMatchSet or IPSet.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

negated

public 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 PredicateType type()

The type of predicate in a Rule, such as ByteMatchSet 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 ByteMatchSet or IPSet.

See Also:

PredicateType

typeAsString

public String typeAsString()

The type of predicate in a Rule, such as ByteMatchSet 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 ByteMatchSet or IPSet.

See Also:

PredicateType

dataId

public 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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<Predicate.Builder,Predicate>

Returns:

a builder for type T

builder

public static Predicate.Builder builder()

serializableBuilderClass

public static Class<? extends Predicate.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.