Package software.amazon.awssdk.services.wafv2.model

Class RateLimitIP

java.lang.Object
software.amazon.awssdk.services.wafv2.model.RateLimitIP
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RateLimitIP.Builder,RateLimitIP>
@Generated("software.amazon.awssdk:codegen") public final class RateLimitIP extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RateLimitIP.Builder,RateLimitIP>

Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.

This setting is used only in the RateBasedStatementCustomKey specification of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP.

JSON specification: "RateLimitIP": {}

See Also:

  • Method Details

    • toBuilder

      public RateLimitIP.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RateLimitIP.Builder,RateLimitIP>
      Returns:
      a builder for type T

    • builder

      public static RateLimitIP.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.