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

Class HTTPRequest

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

Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests.

See Also:

  • Method Details

    • clientIP

      public final String clientIP()

      The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

      • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

      • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

      Returns:
      The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

      • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

      • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

    • country

      public final String country()

      The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

      Returns:
      The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

    • uri

      public final String uri()

      The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

      Returns:
      The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

    • method

      public final String method()

      The HTTP method specified in the sampled web request.

      Returns:
      The HTTP method specified in the sampled web request.

    • httpVersion

      public final String httpVersion()

      The HTTP version specified in the sampled web request, for example, HTTP/1.1.

      Returns:
      The HTTP version specified in the sampled web request, for example, HTTP/1.1.

    • hasHeaders

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

    • headers

      public final List<HTTPHeader> headers()

      A complex type that contains the name and value for each header in the sampled web request.

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

      Returns:
      A complex type that contains the name and value for each header in the sampled web request.

    • toBuilder

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

    • builder

      public static HTTPRequest.Builder builder()

    • serializableBuilderClass

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