blib/lib/Paws/WorkDocs/DescribeFolderContents.pm untested

filter: Statementstmt 0.0% 0 / 26 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 28 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::WorkDocs::DescribeFolderContents;
3 use Moose;
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 use MooseX::ClassAttribute;
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 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::WorkDocs::DescribeFolderContents - Arguments for method DescribeFolderContents on L<Paws::WorkDocs>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method DescribeFolderContents on the
30 L<Amazon WorkDocs|Paws::WorkDocs> service. Use the attributes of this class
31 as arguments to method DescribeFolderContents.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeFolderContents.
34  
35 =head1 SYNOPSIS
36  
37 my $workdocs = Paws->service('WorkDocs');
38 my $DescribeFolderContentsResponse = $workdocs->DescribeFolderContents(
39 FolderId => 'MyResourceIdType',
40 AuthenticationToken => 'MyAuthenticationHeaderType', # OPTIONAL
41 Include => 'MyFieldNamesType', # OPTIONAL
42 Limit => 1, # OPTIONAL
43 Marker => 'MyPageMarkerType', # OPTIONAL
44 Order => 'ASCENDING', # OPTIONAL
45 Sort => 'DATE', # OPTIONAL
46 Type => 'ALL', # OPTIONAL
47 );
48  
49 # Results:
50 my $Documents = $DescribeFolderContentsResponse->Documents;
51 my $Folders = $DescribeFolderContentsResponse->Folders;
52 my $Marker = $DescribeFolderContentsResponse->Marker;
53  
54 # Returns a L<Paws::WorkDocs::DescribeFolderContentsResponse> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/workdocs/DescribeFolderContents>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 AuthenticationToken => Str
63  
64 Amazon WorkDocs authentication token. Not required when using AWS
65 administrator credentials to access the API.
66  
67  
68  
69 =head2 B<REQUIRED> FolderId => Str
70  
71 The ID of the folder.
72  
73  
74  
75 =head2 Include => Str
76  
77 The contents to include. Specify "INITIALIZED" to include initialized
78 documents.
79  
80  
81  
82 =head2 Limit => Int
83  
84 The maximum number of items to return with this call.
85  
86  
87  
88 =head2 Marker => Str
89  
90 The marker for the next set of results. This marker was received from a
91 previous call.
92  
93  
94  
95 =head2 Order => Str
96  
97 The order for the contents of the folder.
98  
99 Valid values are: C<"ASCENDING">, C<"DESCENDING">
100  
101 =head2 Sort => Str
102  
103 The sorting criteria.
104  
105 Valid values are: C<"DATE">, C<"NAME">
106  
107 =head2 Type => Str
108  
109 The type of items.
110  
111 Valid values are: C<"ALL">, C<"DOCUMENT">, C<"FOLDER">
112  
113  
114 =head1 SEE ALSO
115  
116 This class forms part of L<Paws>, documenting arguments for method DescribeFolderContents in L<Paws::WorkDocs>
117  
118 =head1 BUGS and CONTRIBUTIONS
119  
120 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
121  
122 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
123  
124 =cut
125