File Coverage

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