software.amazon.awssdk.services.waf.model

Class HTTPRequest

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<HTTPRequest.Builder,HTTPRequest>

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

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.

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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
String	method() The HTTP method specified in the sampled web request.
static Class<? extends HTTPRequest.Builder>	serializableBuilderClass()
HTTPRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

clientIP

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

headers

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

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

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

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.