@Generated(value="software.amazon.awssdk:codegen") public final class CreateRateBasedRuleRequest extends WafRequest implements ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateRateBasedRuleRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static CreateRateBasedRuleRequest.Builder |
builder() |
String |
changeToken()
The
ChangeToken that you used to submit the CreateRateBasedRule request. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasTags()
Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not
specify the value (it will be empty).
|
String |
metricName()
A friendly name or description for the metrics for this
RateBasedRule . |
String |
name()
A friendly name or description of the RateBasedRule.
|
RateKey |
rateKey()
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
rate monitoring.
|
String |
rateKeyAsString()
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
rate monitoring.
|
Long |
rateLimit()
The maximum number of requests, which have an identical value in the field that is specified by
RateKey , allowed in a five-minute period. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateRateBasedRuleRequest.Builder> |
serializableBuilderClass() |
List<Tag> |
tags()
|
CreateRateBasedRuleRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final String name()
A friendly name or description of the RateBasedRule. You can't change the name of a
RateBasedRule
after you create it.
RateBasedRule
after you create it.public final String metricName()
A friendly name or description for the metrics for this RateBasedRule
. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain
whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name
of the metric after you create the RateBasedRule
.
RateBasedRule
. The name can contain
only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't
contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't
change the name of the metric after you create the RateBasedRule
.public final RateKey rateKey()
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that
requests that arrive from the same IP address are subject to the RateLimit
that is specified in the
RateBasedRule
.
If the service returns an enum value that is not available in the current SDK version, rateKey
will
return RateKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
rateKeyAsString()
.
RateKey
is IP
.
IP
indicates that requests that arrive from the same IP address are subject to the
RateLimit
that is specified in the RateBasedRule
.RateKey
public final String rateKeyAsString()
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
rate monitoring. The only valid value for RateKey
is IP
. IP
indicates that
requests that arrive from the same IP address are subject to the RateLimit
that is specified in the
RateBasedRule
.
If the service returns an enum value that is not available in the current SDK version, rateKey
will
return RateKey.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
rateKeyAsString()
.
RateKey
is IP
.
IP
indicates that requests that arrive from the same IP address are subject to the
RateLimit
that is specified in the RateBasedRule
.RateKey
public final Long rateLimit()
The maximum number of requests, which have an identical value in the field that is specified by
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.
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.public final String changeToken()
The ChangeToken
that you used to submit the CreateRateBasedRule
request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
ChangeToken
that you used to submit the CreateRateBasedRule
request. You
can also use this value to query the status of the request. For more information, see
GetChangeTokenStatus.public final boolean hasTags()
public final List<Tag> tags()
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasTags()
to see if a value was sent in this field.
public CreateRateBasedRuleRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>
toBuilder
in class WafRequest
public static CreateRateBasedRuleRequest.Builder builder()
public static Class<? extends CreateRateBasedRuleRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.