Class AwsWafRateBasedRuleDetails

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

Details about a rate-based rule for global resources. A rate-based rule provides settings to indicate when to allow, block, or count a request. Rate-based rules include the number of requests that arrive over a specified period of time.

See Also:

  • Method Details

    • metricName

      public final String metricName()

      The name of the metrics for the rate-based rule.

      Returns:
      The name of the metrics for the rate-based rule.

    • name

      public final String name()

      The name of the rate-based rule.

      Returns:
      The name of the rate-based rule.

    • rateKey

      public final String rateKey()

      The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

      Returns:
      The field that WAF uses to determine whether requests are likely arriving from single source and are subject to rate monitoring.

    • rateLimit

      public final Long rateLimit()

      The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

      Returns:
      The maximum number of requests that have an identical value for the field specified in RateKey that are allowed within a five-minute period. If the number of requests exceeds RateLimit and the other predicates specified in the rule are met, WAF triggers the action for the rule.

    • ruleId

      public final String ruleId()

      The unique identifier for the rate-based rule.

      Returns:
      The unique identifier for the rate-based rule.

    • hasMatchPredicates

      public final boolean hasMatchPredicates()
      For responses, this returns true if the service returned a value for the MatchPredicates 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.

    • matchPredicates

      public final List<AwsWafRateBasedRuleMatchPredicate> matchPredicates()

      The predicates to include in the rate-based rule.

      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 hasMatchPredicates() method.

      Returns:
      The predicates to include in the rate-based rule.

    • toBuilder

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

    • builder

      public static AwsWafRateBasedRuleDetails.Builder builder()

    • serializableBuilderClass

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