Class AwsWafRuleDetails

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

Provides information about a WAF rule. This rule specifies the web requests that you want to allow, block, or count.

See Also:

  • Method Details

    • metricName

      public final String metricName()

      The name of the metrics for this rule.

      Returns:
      The name of the metrics for this rule.

    • name

      public final String name()

      A descriptive name for the rule.

      Returns:
      A descriptive name for the rule.

    • hasPredicateList

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

    • predicateList

      public final List<AwsWafRulePredicateListDetails> predicateList()

      Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

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

      Returns:
      Specifies the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a rule and, for each object, indicates whether you want to negate the settings.

    • ruleId

      public final String ruleId()

      The ID of the WAF rule.

      Returns:
      The ID of the WAF rule.

    • toBuilder

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

    • builder

      public static AwsWafRuleDetails.Builder builder()

    • serializableBuilderClass

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