« blib/lib/Paws/ApiGateway/GetRequestValidators.pm
↑ Summary
blib/lib/Paws/ApiGateway/GetResources.pm »
| 1 | |||
| 2 | package Paws::ApiGateway::GetResource; | ||
| 3 | use Moose; | ||
| 4 | has Embed => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'embed'); | ||
| 5 | has ResourceId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'resource_id', required => 1); | ||
| 6 | has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restapi_id', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetResource'); | ||
| 11 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/resources/{resource_id}'); | ||
| 12 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Resource'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::ApiGateway::GetResource - Arguments for method GetResource on L<Paws::ApiGateway> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method GetResource on the | ||
| 25 | L<Amazon API Gateway|Paws::ApiGateway> service. Use the attributes of this class | ||
| 26 | as arguments to method GetResource. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetResource. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $apigateway = Paws->service('ApiGateway'); | ||
| 33 | my $Resource = $apigateway->GetResource( | ||
| 34 | ResourceId => 'MyString', | ||
| 35 | RestApiId => 'MyString', | ||
| 36 | Embed => [ 'MyString', ... ], # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Id = $Resource->Id; | ||
| 41 | my $ParentId = $Resource->ParentId; | ||
| 42 | my $Path = $Resource->Path; | ||
| 43 | my $PathPart = $Resource->PathPart; | ||
| 44 | my $ResourceMethods = $Resource->ResourceMethods; | ||
| 45 | |||
| 46 | # Returns a L<Paws::ApiGateway::Resource> object. | ||
| 47 | |||
| 48 | 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. | ||
| 49 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/apigateway/GetResource> | ||
| 50 | |||
| 51 | =head1 ATTRIBUTES | ||
| 52 | |||
| 53 | |||
| 54 | =head2 Embed => ArrayRef[Str|Undef] | ||
| 55 | |||
| 56 | A query parameter to retrieve the specified resources embedded in the | ||
| 57 | returned Resource representation in the response. This C<embed> | ||
| 58 | parameter value is a list of comma-separated strings. Currently, the | ||
| 59 | request supports only retrieval of the embedded Method resources this | ||
| 60 | way. The query parameter value must be a single-valued list and contain | ||
| 61 | the C<"methods"> string. For example, C<GET | ||
| 62 | /restapis/{restapi_id}/resources/{resource_id}?embed=methods>. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> ResourceId => Str | ||
| 67 | |||
| 68 | [Required] The identifier for the Resource resource. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> RestApiId => Str | ||
| 73 | |||
| 74 | [Required] The string identifier of the associated RestApi. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head1 SEE ALSO | ||
| 80 | |||
| 81 | This class forms part of L<Paws>, documenting arguments for method GetResource in L<Paws::ApiGateway> | ||
| 82 | |||
| 83 | =head1 BUGS and CONTRIBUTIONS | ||
| 84 | |||
| 85 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 86 | |||
| 87 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 88 | |||
| 89 | =cut | ||
| 90 |