File Coverage

blib/lib/Paws/ApiGateway/PutRestApi.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::PutRestApi;
3 1     1   422 use Moose;
  1         2  
  1         7  
4             has Body => (is => 'ro', isa => 'Str', required => 1);
5             has FailOnWarnings => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'failOnWarnings' );
6             has Mode => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'mode' );
7             has Parameters => (is => 'ro', isa => 'Paws::ApiGateway::MapOfStringToString', traits => ['ParamInQuery'], query_name => 'parameters' );
8             has RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId' , required => 1);
9              
10 1     1   5871 use MooseX::ClassAttribute;
  1         3  
  1         7  
11             class_has _stream_param => (is => 'ro', default => 'Body');
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutRestApi');
13             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}');
14             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
15             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::RestApi');
16             class_has _result_key => (isa => 'Str', is => 'ro');
17             1;
18              
19             ### main pod documentation begin ###
20              
21             =head1 NAME
22              
23             Paws::ApiGateway::PutRestApi - Arguments for method PutRestApi on Paws::ApiGateway
24              
25             =head1 DESCRIPTION
26              
27             This class represents the parameters used for calling the method PutRestApi on the
28             Amazon API Gateway service. Use the attributes of this class
29             as arguments to method PutRestApi.
30              
31             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutRestApi.
32              
33             As an example:
34              
35             $service_obj->PutRestApi(Att1 => $value1, Att2 => $value2, ...);
36              
37             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.
38              
39             =head1 ATTRIBUTES
40              
41              
42             =head2 B<REQUIRED> Body => Str
43              
44             The PUT request body containing external API definitions. Currently,
45             only Swagger definition JSON files are supported.
46              
47              
48              
49             =head2 FailOnWarnings => Bool
50              
51             A query parameter to indicate whether to rollback the API update
52             (C<true>) or not (C<false>) when a warning is encountered. The default
53             value is C<false>.
54              
55              
56              
57             =head2 Mode => Str
58              
59             The C<mode> query parameter to specify the update mode. Valid values
60             are "merge" and "overwrite". By default, the update mode is "merge".
61              
62             Valid values are: C<"merge">, C<"overwrite">
63              
64             =head2 Parameters => L<Paws::ApiGateway::MapOfStringToString>
65              
66             Custom headers supplied as part of the request.
67              
68              
69              
70             =head2 B<REQUIRED> RestApiId => Str
71              
72             The identifier of the RestApi to be updated.
73              
74              
75              
76              
77             =head1 SEE ALSO
78              
79             This class forms part of L<Paws>, documenting arguments for method PutRestApi in L<Paws::ApiGateway>
80              
81             =head1 BUGS and CONTRIBUTIONS
82              
83             The source code is located here: https://github.com/pplu/aws-sdk-perl
84              
85             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
86              
87             =cut
88