blib/lib/Paws/ApiGateway/GetDocumentationParts.pm untested

filter: Statementstmt 0.0% 0 / 24 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 26 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApiGateway::GetDocumentationParts;
3 use Moose;
4 has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit');
5 has LocationStatus => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'locationStatus');
6 has NameQuery => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'name');
7 has Path => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'path');
8 has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position');
9 has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1);
10 has Type => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'type');
11  
12 use MooseX::ClassAttribute;
13  
14 class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDocumentationParts');
15 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/documentation/parts');
16 class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DocumentationParts');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::ApiGateway::GetDocumentationParts - Arguments for method GetDocumentationParts on L<Paws::ApiGateway>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method GetDocumentationParts on the
29 L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class
30 as arguments to method GetDocumentationParts.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocumentationParts.
33  
34 =head1 SYNOPSIS
35  
36 my $apigateway = Paws->service('ApiGateway');
37 my $DocumentationParts = $apigateway->GetDocumentationParts(
38 RestApiId => 'MyString',
39 Limit => 1, # OPTIONAL
40 LocationStatus => 'DOCUMENTED', # OPTIONAL
41 NameQuery => 'MyString', # OPTIONAL
42 Path => 'MyString', # OPTIONAL
43 Position => 'MyString', # OPTIONAL
44 Type => 'API', # OPTIONAL
45 );
46  
47 # Results:
48 my $Items = $DocumentationParts->Items;
49 my $Position = $DocumentationParts->Position;
50  
51 # Returns a L<Paws::ApiGateway::DocumentationParts> object.
52  
53 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.
54 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetDocumentationParts>
55  
56 =head1 ATTRIBUTES
57  
58  
59 =head2 Limit => Int
60  
61 The maximum number of returned results per page. The default value is
62 25 and the maximum value is 500.
63  
64  
65  
66 =head2 LocationStatus => Str
67  
68 The status of the API documentation parts to retrieve. Valid values are
69 C<DOCUMENTED> for retrieving DocumentationPart resources with content
70 and C<UNDOCUMENTED> for DocumentationPart resources without content.
71  
72 Valid values are: C<"DOCUMENTED">, C<"UNDOCUMENTED">
73  
74 =head2 NameQuery => Str
75  
76 The name of API entities of the to-be-retrieved documentation parts.
77  
78  
79  
80 =head2 Path => Str
81  
82 The path of API entities of the to-be-retrieved documentation parts.
83  
84  
85  
86 =head2 Position => Str
87  
88 The current pagination position in the paged result set.
89  
90  
91  
92 =head2 B<REQUIRED> RestApiId => Str
93  
94 [Required] The string identifier of the associated RestApi.
95  
96  
97  
98 =head2 Type => Str
99  
100 The type of API entities of the to-be-retrieved documentation parts.
101  
102 Valid values are: C<"API">, C<"AUTHORIZER">, C<"MODEL">, C<"RESOURCE">, C<"METHOD">, C<"PATH_PARAMETER">, C<"QUERY_PARAMETER">, C<"REQUEST_HEADER">, C<"REQUEST_BODY">, C<"RESPONSE">, C<"RESPONSE_HEADER">, C<"RESPONSE_BODY">
103  
104  
105 =head1 SEE ALSO
106  
107 This class forms part of L<Paws>, documenting arguments for method GetDocumentationParts in L<Paws::ApiGateway>
108  
109 =head1 BUGS and CONTRIBUTIONS
110  
111 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
112  
113 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
114  
115 =cut
116