Package software.amazon.awssdk.services.waf.model

Class UpdateRateBasedRuleRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.waf.model.WafRequest

software.amazon.awssdk.services.waf.model.UpdateRateBasedRuleRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateRateBasedRuleRequest.Builder,UpdateRateBasedRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateRateBasedRuleRequest
extends WafRequest
implements ToCopyableBuilder<UpdateRateBasedRuleRequest.Builder,UpdateRateBasedRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateRateBasedRuleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateRateBasedRuleRequest.Builder	builder()
String	changeToken()	The value returned by the most recent call to GetChangeToken.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasUpdates()	For responses, this returns true if the service returned a value for the Updates property.
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.
String	ruleId()	The RuleId of the RateBasedRule that you want to update.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateRateBasedRuleRequest.Builder>	serializableBuilderClass()
UpdateRateBasedRuleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<RuleUpdate>	updates()	An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

ruleId

public final String ruleId()

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.

changeToken

public final String changeToken()

The value returned by the most recent call to GetChangeToken.

Returns:

The value returned by the most recent call to GetChangeToken.

hasUpdates

public final boolean hasUpdates()

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

updates

public final List<RuleUpdate> updates()

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

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

Returns:

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

rateLimit

public final 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.

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.

toBuilder

public UpdateRateBasedRuleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateRateBasedRuleRequest.Builder,UpdateRateBasedRuleRequest>

Specified by:

toBuilder in class WafRequest

builder

public static UpdateRateBasedRuleRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo