software.amazon.awssdk.services.waf.model

Class HTTPRequest

java.lang.Object

software.amazon.awssdk.services.waf.model.HTTPRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HTTPRequest.Builder,HTTPRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class HTTPRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HTTPRequest.Builder,HTTPRequest>

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HTTPRequest.Builder

Method Summary

Modifier and Type	Method and Description
static HTTPRequest.Builder	builder()
String	clientIP() The IP address that the request originated from.
String	country() The two-letter country code for the country that the request originated from.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasHeaders() Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
List<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.
String	httpVersion() The HTTP version specified in the sampled web request, for example, HTTP/1.1.
String	method() The HTTP method specified in the sampled web request.
List<SdkField<?>>	sdkFields()
static Class<? extends HTTPRequest.Builder>	serializableBuilderClass()
HTTPRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	uri() The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientIP

public final 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

Returns:

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

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 part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

Returns:

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

method

public final String method()

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

Returns:

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

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()

Returns true if the Headers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

headers

public final List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHeaders() to see if a value was sent in this field.

Returns:

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.

toBuilder

public HTTPRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HTTPRequest.Builder,HTTPRequest>

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)

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