Class HTTPRequest
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic HTTPRequest.Builder
builder()
final String
clientIP()
The IP address that the request originated from.final String
country()
The two-letter country code for the country that the request originated from.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Headers property.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.final String
The HTTP version specified in the sampled web request, for example,HTTP/1.1
.final String
method()
The HTTP method specified in the sampled web request.static Class
<? extends HTTPRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
uri()
The part of a web request that identifies the resource, for example,/images/daily-ad.jpg
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
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
The HTTP method specified in the sampled web request. CloudFront supports the following methods:
DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.- Returns:
- The HTTP method specified in the sampled web request. CloudFront supports the following methods:
DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.
-
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 theisEmpty()
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
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.
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 two values for each header in the sampled web request: the name of the header and the value of the header.
-
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 interfaceToCopyableBuilder<HTTPRequest.Builder,
HTTPRequest> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-