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

Class Filter

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

A single logging filter, used in LoggingFilter.

See Also:

  • Method Details

    • behavior

      public final FilterBehavior behavior()

      How to handle logs that satisfy the filter's conditions and requirement.

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

      Returns:
      How to handle logs that satisfy the filter's conditions and requirement.
      See Also:

    • behaviorAsString

      public final String behaviorAsString()

      How to handle logs that satisfy the filter's conditions and requirement.

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

      Returns:
      How to handle logs that satisfy the filter's conditions and requirement.
      See Also:

    • requirement

      public final FilterRequirement requirement()

      Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

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

      Returns:
      Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.
      See Also:

    • requirementAsString

      public final String requirementAsString()

      Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.

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

      Returns:
      Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.
      See Also:

    • hasConditions

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

    • conditions

      public final List<Condition> conditions()

      Match conditions for the filter.

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

      Returns:
      Match conditions for the filter.

    • toBuilder

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

    • builder

      public static Filter.Builder builder()

    • serializableBuilderClass

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