File Coverage

blib/lib/Paws/WAFRegional/HTTPRequest.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::WAFRegional::HTTPRequest;
2 1     1   508 use Moose;
  1         3  
  1         8  
3             has ClientIP => (is => 'ro', isa => 'Str');
4             has Country => (is => 'ro', isa => 'Str');
5             has Headers => (is => 'ro', isa => 'ArrayRef[Paws::WAFRegional::HTTPHeader]');
6             has HTTPVersion => (is => 'ro', isa => 'Str');
7             has Method => (is => 'ro', isa => 'Str');
8             has URI => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::WAFRegional::HTTPRequest
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::WAFRegional::HTTPRequest object:
27              
28             $service_obj->Method(Att1 => { ClientIP => $value, ..., URI => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::WAFRegional::HTTPRequest object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->ClientIP
36              
37             =head1 DESCRIPTION
38              
39             The response from a GetSampledRequests request includes an
40             C<HTTPRequest> complex type that appears as C<Request> in the response
41             syntax. C<HTTPRequest> contains information about one of the web
42             requests that were returned by C<GetSampledRequests>.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 ClientIP => Str
48              
49             The IP address that the request originated from. If the C<WebACL> is
50             associated with a CloudFront distribution, this is the value of one of
51             the following fields in CloudFront access logs:
52              
53             =over
54              
55             =item *
56              
57             C<c-ip>, if the viewer did not use an HTTP proxy or a load balancer to
58             send the request
59              
60             =item *
61              
62             C<x-forwarded-for>, if the viewer did use an HTTP proxy or a load
63             balancer to send the request
64              
65             =back
66              
67              
68              
69             =head2 Country => Str
70              
71             The two-letter country code for the country that the request originated
72             from. For a current list of country codes, see the Wikipedia entry ISO
73             3166-1 alpha-2.
74              
75              
76             =head2 Headers => ArrayRef[L<Paws::WAFRegional::HTTPHeader>]
77              
78             A complex type that contains two values for each header in the sampled
79             web request: the name of the header and the value of the header.
80              
81              
82             =head2 HTTPVersion => Str
83              
84             The HTTP version specified in the sampled web request, for example,
85             C<HTTP/1.1>.
86              
87              
88             =head2 Method => Str
89              
90             The HTTP method specified in the sampled web request. CloudFront
91             supports the following methods: C<DELETE>, C<GET>, C<HEAD>, C<OPTIONS>,
92             C<PATCH>, C<POST>, and C<PUT>.
93              
94              
95             =head2 URI => Str
96              
97             The part of a web request that identifies the resource, for example,
98             C</images/daily-ad.jpg>.
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, describing an object used in L<Paws::WAFRegional>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113