Package software.amazon.awssdk.services.securityhub.model

Class AwsWafv2RulesDetails

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

Provides details about rules in a rule group. A rule identifies web requests that you want to allow, block, or count. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

See Also:

  • Method Details

    • action

      public final AwsWafv2RulesActionDetails action()

      The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

      Returns:
      The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.

    • name

      public final String name()

      The name of the rule.

      Returns:
      The name of the rule.

    • overrideAction

      public final String overrideAction()

      The action to use in the place of the action that results from the rule group evaluation.

      Returns:
      The action to use in the place of the action that results from the rule group evaluation.

    • priority

      public final Integer priority()

      If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

      Returns:
      If you define more than one Rule in a WebACL, WAF evaluates each request against the Rules in order based on the value of Priority. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.

    • visibilityConfig

      public final AwsWafv2VisibilityConfigDetails visibilityConfig()

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      Returns:
      Defines and enables Amazon CloudWatch metrics and web request sample collection.

    • toBuilder

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

    • builder

      public static AwsWafv2RulesDetails.Builder builder()

    • serializableBuilderClass

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