File Coverage

blib/lib/Paws/ApiGateway/CreateBasePathMapping.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::CreateBasePathMapping;
3 1     1   516 use Moose;
  1         2  
  1         8  
4             has BasePath => (is => 'ro', isa => 'Str');
5             has DomainName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'domainName' , required => 1);
6             has RestApiId => (is => 'ro', isa => 'Str', required => 1);
7             has Stage => (is => 'ro', isa => 'Str');
8              
9 1     1   6052 use MooseX::ClassAttribute;
  1         3  
  1         9  
10              
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateBasePathMapping');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/domainnames/{domain_name}/basepathmappings');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::BasePathMapping');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ApiGateway::CreateBasePathMapping - Arguments for method CreateBasePathMapping on Paws::ApiGateway
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method CreateBasePathMapping on the
27             Amazon API Gateway service. Use the attributes of this class
28             as arguments to method CreateBasePathMapping.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateBasePathMapping.
31              
32             As an example:
33              
34             $service_obj->CreateBasePathMapping(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 BasePath => Str
42              
43             The base path name that callers of the API must provide as part of the
44             URL after the domain name. This value must be unique for all of the
45             mappings across a single API. Leave this blank if you do not want
46             callers to specify a base path name after the domain name.
47              
48              
49              
50             =head2 B<REQUIRED> DomainName => Str
51              
52             The domain name of the BasePathMapping resource to create.
53              
54              
55              
56             =head2 B<REQUIRED> RestApiId => Str
57              
58             The string identifier of the associated RestApi.
59              
60              
61              
62             =head2 Stage => Str
63              
64             The name of the API's stage that you want to use for this mapping.
65             Leave this blank if you do not want callers to explicitly specify the
66             stage name after any base path name.
67              
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, documenting arguments for method CreateBasePathMapping in L<Paws::ApiGateway>
74              
75             =head1 BUGS and CONTRIBUTIONS
76              
77             The source code is located here: https://github.com/pplu/aws-sdk-perl
78              
79             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
80              
81             =cut
82