File Coverage

blib/lib/Paws/ApiGateway/DocumentationPartLocation.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::ApiGateway::DocumentationPartLocation;
2 1     1   661 use Moose;
  1         3  
  1         6  
3             has Method => (is => 'ro', isa => 'Str', request_name => 'method', traits => ['NameInRequest']);
4             has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']);
5             has Path => (is => 'ro', isa => 'Str', request_name => 'path', traits => ['NameInRequest']);
6             has StatusCode => (is => 'ro', isa => 'Str', request_name => 'statusCode', traits => ['NameInRequest']);
7             has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest'], required => 1);
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::ApiGateway::DocumentationPartLocation
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::ApiGateway::DocumentationPartLocation object:
26              
27             $service_obj->Method(Att1 => { Method => $value, ..., Type => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::DocumentationPartLocation object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->Method
35              
36             =head1 DESCRIPTION
37              
38             Specifies the target API entity to which the documentation applies.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 Method => Str
44              
45             The HTTP verb of a method. It is a valid field for the API entity types
46             of C<METHOD>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>, C<REQUEST_HEADER>,
47             C<REQUEST_BODY>, C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>.
48             The default value is C<*> for any method. When an applicable child
49             entity inherits the content of an entity of the same type with more
50             general specifications of the other C<location> attributes, the child
51             entity's C<method> attribute must match that of the parent entity
52             exactly.
53              
54              
55             =head2 Name => Str
56              
57             The name of the targeted API entity. It is a valid and required field
58             for the API entity types of C<AUTHORIZER>, C<MODEL>, C<PATH_PARAMETER>,
59             C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY> and
60             C<RESPONSE_HEADER>. It is an invalid field for any other entity type.
61              
62              
63             =head2 Path => Str
64              
65             The URL path of the target. It is a valid field for the API entity
66             types of C<RESOURCE>, C<METHOD>, C<PATH_PARAMETER>, C<QUERY_PARAMETER>,
67             C<REQUEST_HEADER>, C<REQUEST_BODY>, C<RESPONSE>, C<RESPONSE_HEADER>,
68             and C<RESPONSE_BODY>. The default value is C</> for the root resource.
69             When an applicable child entity inherits the content of another entity
70             of the same type with more general specifications of the other
71             C<location> attributes, the child entity's C<path> attribute must match
72             that of the parent entity as a prefix.
73              
74              
75             =head2 StatusCode => Str
76              
77             The HTTP status code of a response. It is a valid field for the API
78             entity types of C<RESPONSE>, C<RESPONSE_HEADER>, and C<RESPONSE_BODY>.
79             The default value is C<*> for any status code. When an applicable child
80             entity inherits the content of an entity of the same type with more
81             general specifications of the other C<location> attributes, the child
82             entity's C<statusCode> attribute must match that of the parent entity
83             exactly.
84              
85              
86             =head2 B<REQUIRED> Type => Str
87              
88             The type of API entity to which the documentation content applies. It
89             is a valid and required field for API entity types of C<API>,
90             C<AUTHORIZER>, C<MODEL>, C<RESOURCE>, C<METHOD>, C<PATH_PARAMETER>,
91             C<QUERY_PARAMETER>, C<REQUEST_HEADER>, C<REQUEST_BODY>, C<RESPONSE>,
92             C<RESPONSE_HEADER>, and C<RESPONSE_BODY>. Content inheritance does not
93             apply to any entity of the C<API>, C<AUTHROZER>, C<METHOD>, C<MODEL>,
94             C<REQUEST_BODY>, or C<RESOURCE> type.
95              
96              
97              
98             =head1 SEE ALSO
99              
100             This class forms part of L<Paws>, describing an object used in L<Paws::ApiGateway>
101              
102             =head1 BUGS and CONTRIBUTIONS
103              
104             The source code is located here: https://github.com/pplu/aws-sdk-perl
105              
106             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
107              
108             =cut
109