software.amazon.awssdk.services.securityhub.model

Class AwsWafRuleDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafRuleDetails

All Implemented Interfaces:

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

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

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsWafRuleDetails.Builder

Method Summary

Modifier and Type	Method and Description
static AwsWafRuleDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPredicateList() For responses, this returns true if the service returned a value for the PredicateList property.
String	metricName() The name of the metrics for this rule.
String	name() A descriptive name for the rule.
List<AwsWafRulePredicateListDetails>	predicateList() 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.
String	ruleId() The ID of the WAF rule.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafRuleDetails.Builder>	serializableBuilderClass()
AwsWafRuleDetails.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

metricName

public final String metricName()

The name of the metrics for this rule.

Returns:

The name of the metrics for this rule.

name

public final String name()

A descriptive name for the rule.

Returns:

A descriptive name for the rule.

hasPredicateList

public final boolean hasPredicateList()

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

predicateList

public final List<AwsWafRulePredicateListDetails> predicateList()

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.

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

Returns:

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.

ruleId

public final String ruleId()

The ID of the WAF rule.

Returns:

The ID of the WAF rule.

toBuilder

public AwsWafRuleDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafRuleDetails.Builder,AwsWafRuleDetails>

builder

public static AwsWafRuleDetails.Builder builder()

serializableBuilderClass

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