@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AwsWafRegionalRateBasedRuleDetails extends Object implements Serializable, Cloneable, StructuredPojo
contains details about a rate-based rule for Regional 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.
Constructor and Description |
---|
AwsWafRegionalRateBasedRuleDetails() |
Modifier and Type | Method and Description |
---|---|
AwsWafRegionalRateBasedRuleDetails |
clone() |
boolean |
equals(Object obj) |
List<AwsWafRegionalRateBasedRuleMatchPredicate> |
getMatchPredicates()
The predicates to include in the rate-based rule.
|
String |
getMetricName()
The name of the metrics for the rate-based rule.
|
String |
getName()
The name of the rate-based rule.
|
String |
getRateKey()
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to
rate monitoring.
|
Long |
getRateLimit()
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 |
getRuleId()
The unique identifier for the rate-based rule.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setMatchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates)
The predicates to include in the rate-based rule.
|
void |
setMetricName(String metricName)
The name of the metrics for the rate-based rule.
|
void |
setName(String name)
The name of the rate-based rule.
|
void |
setRateKey(String rateKey)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to
rate monitoring.
|
void |
setRateLimit(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. |
void |
setRuleId(String ruleId)
The unique identifier for the rate-based rule.
|
String |
toString()
Returns a string representation of this object.
|
AwsWafRegionalRateBasedRuleDetails |
withMatchPredicates(AwsWafRegionalRateBasedRuleMatchPredicate... matchPredicates)
The predicates to include in the rate-based rule.
|
AwsWafRegionalRateBasedRuleDetails |
withMatchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates)
The predicates to include in the rate-based rule.
|
AwsWafRegionalRateBasedRuleDetails |
withMetricName(String metricName)
The name of the metrics for the rate-based rule.
|
AwsWafRegionalRateBasedRuleDetails |
withName(String name)
The name of the rate-based rule.
|
AwsWafRegionalRateBasedRuleDetails |
withRateKey(String rateKey)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to
rate monitoring.
|
AwsWafRegionalRateBasedRuleDetails |
withRateLimit(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. |
AwsWafRegionalRateBasedRuleDetails |
withRuleId(String ruleId)
The unique identifier for the rate-based rule.
|
public void setMetricName(String metricName)
The name of the metrics for the rate-based rule.
metricName
- The name of the metrics for the rate-based rule.public String getMetricName()
The name of the metrics for the rate-based rule.
public AwsWafRegionalRateBasedRuleDetails withMetricName(String metricName)
The name of the metrics for the rate-based rule.
metricName
- The name of the metrics for the rate-based rule.public void setName(String name)
The name of the rate-based rule.
name
- The name of the rate-based rule.public String getName()
The name of the rate-based rule.
public AwsWafRegionalRateBasedRuleDetails withName(String name)
The name of the rate-based rule.
name
- The name of the rate-based rule.public void setRateKey(String rateKey)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
rateKey
- The field that WAF uses to determine whether requests are likely arriving from single source and are
subject to rate monitoring.public String getRateKey()
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
public AwsWafRegionalRateBasedRuleDetails withRateKey(String rateKey)
The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.
rateKey
- The field that WAF uses to determine whether requests are likely arriving from single source and are
subject to rate monitoring.public void setRateLimit(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.
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.public Long getRateLimit()
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.
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.public AwsWafRegionalRateBasedRuleDetails withRateLimit(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.
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.public void setRuleId(String ruleId)
The unique identifier for the rate-based rule.
ruleId
- The unique identifier for the rate-based rule.public String getRuleId()
The unique identifier for the rate-based rule.
public AwsWafRegionalRateBasedRuleDetails withRuleId(String ruleId)
The unique identifier for the rate-based rule.
ruleId
- The unique identifier for the rate-based rule.public List<AwsWafRegionalRateBasedRuleMatchPredicate> getMatchPredicates()
The predicates to include in the rate-based rule.
public void setMatchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates)
The predicates to include in the rate-based rule.
matchPredicates
- The predicates to include in the rate-based rule.public AwsWafRegionalRateBasedRuleDetails withMatchPredicates(AwsWafRegionalRateBasedRuleMatchPredicate... matchPredicates)
The predicates to include in the rate-based rule.
NOTE: This method appends the values to the existing list (if any). Use
setMatchPredicates(java.util.Collection)
or withMatchPredicates(java.util.Collection)
if you
want to override the existing values.
matchPredicates
- The predicates to include in the rate-based rule.public AwsWafRegionalRateBasedRuleDetails withMatchPredicates(Collection<AwsWafRegionalRateBasedRuleMatchPredicate> matchPredicates)
The predicates to include in the rate-based rule.
matchPredicates
- The predicates to include in the rate-based rule.public String toString()
toString
in class Object
Object.toString()
public AwsWafRegionalRateBasedRuleDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.