File Coverage

blib/lib/Paws/ApiGateway/GetUsage.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApiGateway::GetUsage;
3 1     1   513 use Moose;
  1         2  
  1         7  
4             has EndDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'endDate' , required => 1);
5             has KeyId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'keyId' );
6             has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit' );
7             has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position' );
8             has StartDate => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'startDate' , required => 1);
9             has UsagePlanId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'usagePlanId' , required => 1);
10              
11 1     1   6358 use MooseX::ClassAttribute;
  1         2  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetUsage');
14             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/usageplans/{usageplanId}/usage');
15             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Usage');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::ApiGateway::GetUsage - Arguments for method GetUsage on Paws::ApiGateway
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method GetUsage on the
29             Amazon API Gateway service. Use the attributes of this class
30             as arguments to method GetUsage.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetUsage.
33              
34             As an example:
35              
36             $service_obj->GetUsage(Att1 => $value1, Att2 => $value2, ...);
37              
38             Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> EndDate => Str
44              
45             The ending date (e.g., 2016-12-31) of the usage data.
46              
47              
48              
49             =head2 KeyId => Str
50              
51             The Id of the API key associated with the resultant usage data.
52              
53              
54              
55             =head2 Limit => Int
56              
57             The maximum number of returned results per page.
58              
59              
60              
61             =head2 Position => Str
62              
63             The current pagination position in the paged result set.
64              
65              
66              
67             =head2 B<REQUIRED> StartDate => Str
68              
69             The starting date (e.g., 2016-01-01) of the usage data.
70              
71              
72              
73             =head2 B<REQUIRED> UsagePlanId => Str
74              
75             The Id of the usage plan associated with the usage data.
76              
77              
78              
79              
80             =head1 SEE ALSO
81              
82             This class forms part of L<Paws>, documenting arguments for method GetUsage in L<Paws::ApiGateway>
83              
84             =head1 BUGS and CONTRIBUTIONS
85              
86             The source code is located here: https://github.com/pplu/aws-sdk-perl
87              
88             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
89              
90             =cut
91