File Coverage

blib/lib/Paws/ApiGateway/ImportDocumentationParts.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::ImportDocumentationParts;
3 1     1   590 use Moose;
  1         4  
  1         10  
4             has Body => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'body', 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 RestApiId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'restApiId', required => 1);
8              
9 1     1   10936 use MooseX::ClassAttribute;
  1         3  
  1         13  
10             class_has _stream_param => (is => 'ro', default => 'Body');
11             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ImportDocumentationParts');
12             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restapis/{restapi_id}/documentation/parts');
13             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApiGateway::DocumentationPartIds');
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::ImportDocumentationParts - Arguments for method ImportDocumentationParts on Paws::ApiGateway
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method ImportDocumentationParts on the
27             Amazon API Gateway service. Use the attributes of this class
28             as arguments to method ImportDocumentationParts.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ImportDocumentationParts.
31              
32             As an example:
33              
34             $service_obj->ImportDocumentationParts(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 B<REQUIRED> Body => Str
42              
43             [Required] Raw byte array representing the to-be-imported documentation
44             parts. To import from a Swagger file, this is a JSON object.
45              
46              
47              
48             =head2 FailOnWarnings => Bool
49              
50             A query parameter to specify whether to rollback the documentation
51             importation (C<true>) or not (C<false>) when a warning is encountered.
52             The default value is C<false>.
53              
54              
55              
56             =head2 Mode => Str
57              
58             A query parameter to indicate whether to overwrite (C<OVERWRITE>) any
59             existing DocumentationParts definition or to merge (C<MERGE>) the new
60             definition into the existing one. The default value is C<MERGE>.
61              
62             Valid values are: C<"merge">, C<"overwrite">
63              
64             =head2 B<REQUIRED> RestApiId => Str
65              
66             [Required] The string identifier of the associated RestApi.
67              
68              
69              
70              
71             =head1 SEE ALSO
72              
73             This class forms part of L<Paws>, documenting arguments for method ImportDocumentationParts 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