Package software.amazon.awssdk.services.waf.model

Interface HTTPRequest.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HTTPRequest.Builder,HTTPRequest>, SdkBuilder<HTTPRequest.Builder,HTTPRequest>, SdkPojo
Enclosing class:
HTTPRequest
public static interface HTTPRequest.Builder extends SdkPojo, CopyableBuilder<HTTPRequest.Builder,HTTPRequest>

  • Method Details

    • clientIP

      HTTPRequest.Builder clientIP(String clientIP)

      The IP address that the request originated from. If the WebACL 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

      Parameters:
      clientIP - The IP address that the request originated from. If the WebACL 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:
      Returns a reference to this object so that method calls can be chained together.

    • country

      HTTPRequest.Builder country(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • uri

      HTTPRequest.Builder uri(String uri)

      The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

      Parameters:
      uri - The part of a web request that identifies the resource, for example, /images/daily-ad.jpg .
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • method

      HTTPRequest.Builder method(String method)

      The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

      Parameters:
      method - The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • httpVersion

      HTTPRequest.Builder httpVersion(String httpVersion)

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

      Parameters:
      httpVersion - The HTTP version specified in the sampled web request, for example, HTTP/1.1.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      HTTPRequest.Builder headers(Collection<HTTPHeader> headers)

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

      Parameters:
      headers - A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      HTTPRequest.Builder headers(HTTPHeader... headers)

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

      Parameters:
      headers - A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • headers

      HTTPRequest.Builder headers(Consumer<HTTPHeader.Builder>... headers)

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

      This is a convenience method that creates an instance of the HTTPHeader.Builder avoiding the need to create one manually via HTTPHeader.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to headers(List<HTTPHeader>).

      Parameters:
      headers - a consumer that will call methods on HTTPHeader.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: