File Coverage

blib/lib/Paws/ApiGateway/GetDocumentationParts.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	sub	time	code
1
2				package Paws::ApiGateway::GetDocumentationParts;
3	1	1	608	use Moose;
	1		4
	1		10
4				has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit');
5				has NameQuery => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nameQuery');
6				has Path => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'path');
7				has Position => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'position');
8				has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId', required => 1);
9				has Type => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'type');
10
11	1	1	10690	use MooseX::ClassAttribute;
	1		5
	1		17
12
13				class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDocumentationParts');
14				class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/documentation/parts');
15				class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
16				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DocumentationParts');
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::GetDocumentationParts - Arguments for method GetDocumentationParts on Paws::ApiGateway
25
26				=head1 DESCRIPTION
27
28				This class represents the parameters used for calling the method GetDocumentationParts on the
29				Amazon API Gateway 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				As an example:
35
36				$service_obj->GetDocumentationParts(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 Limit => Int
44
45				The maximum number of returned results per page.
46
47
48
49				=head2 NameQuery => Str
50
51				The name of API entities of the to-be-retrieved documentation parts.
52
53
54
55				=head2 Path => Str
56
57				The path of API entities of the to-be-retrieved documentation parts.
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> RestApiId => Str
68
69				[Required] The string identifier of the associated RestApi.
70
71
72
73				=head2 Type => Str
74
75				The type of API entities of the to-be-retrieved documentation parts.
76
77				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">
78
79
80				=head1 SEE ALSO
81
82				This class forms part of L<Paws>, documenting arguments for method GetDocumentationParts 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