@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()
For responses, this returns true if the service returned a value for the Tags property.
|
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.
|
overrideConfigurationcopypublic 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.RateKeypublic 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.RateKeypublic 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()
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.public final List<Tag> tags()
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 hasTags() method.
public CreateRateBasedRuleRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>toBuilder in class WafRequestpublic static CreateRateBasedRuleRequest.Builder builder()
public static Class<? extends CreateRateBasedRuleRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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 SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.