File Coverage

blib/lib/Paws/ApiGateway/GetResources.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::GetResources;
3 1     1   467 use Moose;
  1         3  
  1         14  
4             has Embed => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'embed');
5             has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit');
6             has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position');
7             has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId', required => 1);
8              
9 1     1   7234 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetResources');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Resources');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ApiGateway::GetResources - Arguments for method GetResources on Paws::ApiGateway
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method GetResources on the
27             Amazon API Gateway service. Use the attributes of this class
28             as arguments to method GetResources.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResources.
31              
32             As an example:
33              
34             $service_obj->GetResources(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 Embed => ArrayRef[Str|Undef]
42              
43             A query parameter used to retrieve the specified resources embedded in
44             the returned Resources resource in the response. This C<embed>
45             parameter value is a list of comma-separated strings. Currently, the
46             request supports only retrieval of the embedded Method resources this
47             way. The query parameter value must be a single-valued list and contain
48             the C<"methods"> string. For example, C<GET
49             /restapis/{restapi_id}/resources?embed=methods>.
50              
51              
52              
53             =head2 Limit => Int
54              
55             The maximum number of returned results per page. The value is 25 by
56             default and could be between 1 - 500.
57              
58              
59              
60             =head2 Position => Str
61              
62             The current pagination position in the paged result set.
63              
64              
65              
66             =head2 B<REQUIRED> RestApiId => Str
67              
68             The string identifier of the associated RestApi.
69              
70              
71              
72              
73             =head1 SEE ALSO
74              
75             This class forms part of L<Paws>, documenting arguments for method GetResources in L<Paws::ApiGateway>
76              
77             =head1 BUGS and CONTRIBUTIONS
78              
79             The source code is located here: https://github.com/pplu/aws-sdk-perl
80              
81             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
82              
83             =cut
84