File Coverage

blib/lib/Paws/ApiGateway/GetDeployment.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 bran cond sub pod time code
1              
2             package Paws::ApiGateway::GetDeployment;
3 1     1   572 use Moose;
  1         4  
  1         8  
4             has DeploymentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'deploymentId', required => 1);
5             has Embed => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['ParamInQuery'], query_name => 'embed');
6             has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId', required => 1);
7              
8 1     1   9771 use MooseX::ClassAttribute;
  1         3  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDeployment');
11             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/deployments/{deployment_id}');
12             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::Deployment');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::ApiGateway::GetDeployment - Arguments for method GetDeployment on Paws::ApiGateway
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method GetDeployment on the
26             Amazon API Gateway service. Use the attributes of this class
27             as arguments to method GetDeployment.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDeployment.
30              
31             As an example:
32              
33             $service_obj->GetDeployment(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 B<REQUIRED> DeploymentId => Str
41              
42             The identifier of the Deployment resource to get information about.
43              
44              
45              
46             =head2 Embed => ArrayRef[Str|Undef]
47              
48             A query parameter to retrieve the specified embedded resources of the
49             returned Deployment resource in the response. In a REST API call, this
50             C<embed> parameter value is a list of comma-separated strings, as in
51             C<GET
52             /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2>.
53             The SDK and other platform-dependent libraries might use a different
54             format for the list. Currently, this request supports only retrieval of
55             the embedded API summary this way. Hence, the parameter value must be a
56             single-valued list containing only the C<"apisummary"> string. For
57             example, C<GET
58             /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary>.
59              
60              
61              
62             =head2 B<REQUIRED> RestApiId => Str
63              
64             The string identifier of the associated RestApi.
65              
66              
67              
68              
69             =head1 SEE ALSO
70              
71             This class forms part of L<Paws>, documenting arguments for method GetDeployment in L<Paws::ApiGateway>
72              
73             =head1 BUGS and CONTRIBUTIONS
74              
75             The source code is located here: https://github.com/pplu/aws-sdk-perl
76              
77             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
78              
79             =cut
80