Package software.amazon.awssdk.services.securityhub.model

Class AwsWafRateBasedRuleDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsWafRateBasedRuleDetails

All Implemented Interfaces:

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

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

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsWafRateBasedRuleDetails.Builder

Method Summary

Modifier and Type	Method	Description
static AwsWafRateBasedRuleDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchPredicates()	For responses, this returns true if the service returned a value for the MatchPredicates property.
List<AwsWafRateBasedRuleMatchPredicate>	matchPredicates()	The predicates to include in the rate-based rule.
String	metricName()	The name of the metrics for the rate-based rule.
String	name()	The name of the rate-based rule.
String	rateKey()	The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
Long	rateLimit()	The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period.
String	ruleId()	The unique identifier for the rate-based rule.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsWafRateBasedRuleDetails.Builder>	serializableBuilderClass()
AwsWafRateBasedRuleDetails.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 the rate-based rule.

Returns:

The name of the metrics for the rate-based rule.

name

public final String name()

The name of the rate-based rule.

Returns:

The name of the rate-based rule.

rateKey

public final String rateKey()

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

Returns:

The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

rateLimit

public final Long rateLimit()

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

Returns:

The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

ruleId

public final String ruleId()

The unique identifier for the rate-based rule.

Returns:

The unique identifier for the rate-based rule.

hasMatchPredicates

public final boolean hasMatchPredicates()

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

matchPredicates

public final List<AwsWafRateBasedRuleMatchPredicate> matchPredicates()

The predicates to include in the rate-based rule.

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

Returns:

The predicates to include in the rate-based rule.

toBuilder

public AwsWafRateBasedRuleDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsWafRateBasedRuleDetails.Builder,AwsWafRateBasedRuleDetails>

builder

public static AwsWafRateBasedRuleDetails.Builder builder()

serializableBuilderClass

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