Class RateLimitLabelNamespace

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

Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.

This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.

For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.

See Also:

  • Method Details

    • namespace

      public final String namespace()

      The namespace to use for aggregation.

      Returns:
      The namespace to use for aggregation.

    • toBuilder

      public RateLimitLabelNamespace.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<RateLimitLabelNamespace.Builder,RateLimitLabelNamespace>
      Returns:
      a builder for type T

    • builder

      public static RateLimitLabelNamespace.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RateLimitLabelNamespace.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.