Class WafBotControlConfig

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

Describes the configuration of the bot control Web Application Firewall (WAF) rule group.

See Also:

  • Method Details

    • inspectionLevel

      public final WafInspectionLevelEnum inspectionLevel()

      The inspection level of the bot control rule group.

      The following inspection levels are possible:

      • COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.

      • TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.

      If the service returns an enum value that is not available in the current SDK version, inspectionLevel will return WafInspectionLevelEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inspectionLevelAsString().

      Returns:
      The inspection level of the bot control rule group.

      The following inspection levels are possible:

      • COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.

      • TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.

      See Also:

    • inspectionLevelAsString

      public final String inspectionLevelAsString()

      The inspection level of the bot control rule group.

      The following inspection levels are possible:

      • COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.

      • TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.

      If the service returns an enum value that is not available in the current SDK version, inspectionLevel will return WafInspectionLevelEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from inspectionLevelAsString().

      Returns:
      The inspection level of the bot control rule group.

      The following inspection levels are possible:

      • COMMON – Detects a variety of bots that identify themselves, such as web scraping frameworks, search engines, and automated browsers.

      • TARGETED – Includes the COMMON protections, and adds detection for sophisticated bots that don't identify themselves. This level uses rate limiting, CAPTCHA, and background browser challenges.

      See Also:

    • toBuilder

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

    • builder

      public static WafBotControlConfig.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.