File Coverage

blib/lib/Paws/WorkDocs/DescribeDocumentVersions.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::WorkDocs::DescribeDocumentVersions;
3 1     1   293 use Moose;
  1         3  
  1         7  
4             has AuthenticationToken => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'Authentication' );
5             has DocumentId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'DocumentId' , required => 1);
6             has Fields => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'fields' );
7             has Include => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'include' );
8             has Limit => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'limit' );
9             has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker' );
10              
11 1     1   5418 use MooseX::ClassAttribute;
  1         2  
  1         7  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeDocumentVersions');
14             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}/versions');
15             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::DescribeDocumentVersionsResponse');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::WorkDocs::DescribeDocumentVersions - Arguments for method DescribeDocumentVersions on Paws::WorkDocs
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method DescribeDocumentVersions on the
29             Amazon WorkDocs service. Use the attributes of this class
30             as arguments to method DescribeDocumentVersions.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDocumentVersions.
33              
34             As an example:
35              
36             $service_obj->DescribeDocumentVersions(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 AuthenticationToken => Str
44              
45             Amazon WorkDocs authentication token. This field should not be set when
46             using administrative API actions, as in accessing the API using AWS
47             credentials.
48              
49              
50              
51             =head2 B<REQUIRED> DocumentId => Str
52              
53             The ID of the document.
54              
55              
56              
57             =head2 Fields => Str
58              
59             Specify "SOURCE" to include initialized versions and a URL for the
60             source document.
61              
62              
63              
64             =head2 Include => Str
65              
66             A comma-separated list of values. Specify "INITIALIZED" to include
67             incomplete versions.
68              
69              
70              
71             =head2 Limit => Int
72              
73             The maximum number of versions to return with this call.
74              
75              
76              
77             =head2 Marker => Str
78              
79             The marker for the next set of results. (You received this marker from
80             a previous call.)
81              
82              
83              
84              
85             =head1 SEE ALSO
86              
87             This class forms part of L<Paws>, documenting arguments for method DescribeDocumentVersions in L<Paws::WorkDocs>
88              
89             =head1 BUGS and CONTRIBUTIONS
90              
91             The source code is located here: https://github.com/pplu/aws-sdk-perl
92              
93             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
94              
95             =cut
96