File Coverage

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