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

Class SingleHeader

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

Inspect one of the headers in the web request, identified by name, for example, User-Agent or Referer. The name isn't case sensitive.

You can filter and inspect all headers with the FieldToMatch setting Headers.

This is used to indicate the web request component to inspect, in the FieldToMatch specification.

Example JSON: "SingleHeader": { "Name": "haystack" }

See Also:

  • Method Details

    • name

      public final String name()

      The name of the query header to inspect.

      Returns:
      The name of the query header to inspect.

    • toBuilder

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

    • builder

      public static SingleHeader.Builder builder()

    • serializableBuilderClass

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