Package software.amazon.awssdk.services.wafv2.model

Class LoggingFilter

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

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's LoggingConfiguration.

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.

See Also:

  • Method Details

    • hasFilters

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

    • filters

      public final List<Filter> filters()

      The filters that you want to apply to the logs.

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

      Returns:
      The filters that you want to apply to the logs.

    • defaultBehavior

      public final FilterBehavior defaultBehavior()

      Default handling for logs that don't match any of the specified filtering conditions.

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

      Returns:
      Default handling for logs that don't match any of the specified filtering conditions.
      See Also:

    • defaultBehaviorAsString

      public final String defaultBehaviorAsString()

      Default handling for logs that don't match any of the specified filtering conditions.

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

      Returns:
      Default handling for logs that don't match any of the specified filtering conditions.
      See Also:

    • toBuilder

      public LoggingFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<LoggingFilter.Builder,LoggingFilter>

    • builder

      public static LoggingFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LoggingFilter.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo