CreateRateBasedRuleRequest (AWS Java SDK :: Services

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.CreateRateBasedRuleRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateRateBasedRuleRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateRateBasedRuleRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`String`	`toString()` Returns a string representation of this object.

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
  - name
```
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.
    
    Returns:
    
    A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.
  - metricName
```
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.
    
    Returns:
    
    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.
  - rateKey
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    RateKey
  - rateKeyAsString
```
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().
    
    Returns:
    
    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.
    
    See Also:
    
    RateKey
  - rateLimit
```
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.
    
    Returns:
    
    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.
  - changeToken
```
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.
    
    Returns:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
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.
    
    Returns:
  - toBuilder
```
public CreateRateBasedRuleRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>
    
    Specified by:
    
    toBuilder in class WafRequest
  - builder
```
public static CreateRateBasedRuleRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRateBasedRuleRequest.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

Class CreateRateBasedRuleRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

metricName

rateKey

rateKeyAsString

rateLimit

changeToken

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields