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