com.amazonaws.services.waf.model

Class UpdateRateBasedRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.waf.model.UpdateRateBasedRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateRateBasedRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateRateBasedRuleRequest()

Method Summary

Modifier and Type	Method and Description
UpdateRateBasedRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeToken() The value returned by the most recent call to GetChangeToken.
Long	getRateLimit() The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
String	getRuleId() The RuleId of the RateBasedRule that you want to update.
List<RuleUpdate>	getUpdates() An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
int	hashCode()
void	setChangeToken(String changeToken) The value returned by the most recent call to GetChangeToken.
void	setRateLimit(Long rateLimit) The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
void	setRuleId(String ruleId) The RuleId of the RateBasedRule that you want to update.
void	setUpdates(Collection<RuleUpdate> updates) An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
String	toString() Returns a string representation of this object.
UpdateRateBasedRuleRequest	withChangeToken(String changeToken) The value returned by the most recent call to GetChangeToken.
UpdateRateBasedRuleRequest	withRateLimit(Long rateLimit) The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period.
UpdateRateBasedRuleRequest	withRuleId(String ruleId) The RuleId of the RateBasedRule that you want to update.
UpdateRateBasedRuleRequest	withUpdates(Collection<RuleUpdate> updates) An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
UpdateRateBasedRuleRequest	withUpdates(RuleUpdate... updates) An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateRateBasedRuleRequest

public UpdateRateBasedRuleRequest()

Method Detail

setRuleId

public void setRuleId(String ruleId)

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

Parameters:

ruleId - The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

getRuleId

public String getRuleId()

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

Returns:

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

withRuleId

public UpdateRateBasedRuleRequest withRuleId(String ruleId)

The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

Parameters:

ruleId - The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

Returns:

Returns a reference to this object so that method calls can be chained together.

setChangeToken

public void setChangeToken(String changeToken)

The value returned by the most recent call to GetChangeToken.

Parameters:

changeToken - The value returned by the most recent call to GetChangeToken.

getChangeToken

public String getChangeToken()

The value returned by the most recent call to GetChangeToken.

Returns:

The value returned by the most recent call to GetChangeToken.

withChangeToken

public UpdateRateBasedRuleRequest withChangeToken(String changeToken)

The value returned by the most recent call to GetChangeToken.

Parameters:

changeToken - The value returned by the most recent call to GetChangeToken.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUpdates

public List<RuleUpdate> getUpdates()

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Returns:

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

setUpdates

public void setUpdates(Collection<RuleUpdate> updates)

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Parameters:

updates - An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

withUpdates

public UpdateRateBasedRuleRequest withUpdates(RuleUpdate... updates)

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

NOTE: This method appends the values to the existing list (if any). Use setUpdates(java.util.Collection) or withUpdates(java.util.Collection) if you want to override the existing values.

Parameters:

updates - An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUpdates

public UpdateRateBasedRuleRequest withUpdates(Collection<RuleUpdate> updates)

An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Parameters:

updates - An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRateLimit

public void setRateLimit(Long rateLimit)

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

Parameters:

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

getRateLimit

public Long getRateLimit()

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

Returns:

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

withRateLimit

public UpdateRateBasedRuleRequest withRateLimit(Long rateLimit)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateRateBasedRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()