File Coverage

blib/lib/Paws/WorkDocs/GetDocument.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::GetDocument;
3 1     1   315 use Moose;
  1         2  
  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 IncludeCustomMetadata => (is => 'ro', isa => 'Bool', traits => ['ParamInQuery'], query_name => 'includeCustomMetadata' );
7              
8 1     1   5529 use MooseX::ClassAttribute;
  1         2  
  1         7  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetDocument');
11             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/api/v1/documents/{DocumentId}');
12             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::WorkDocs::GetDocumentResponse');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::WorkDocs::GetDocument - Arguments for method GetDocument on Paws::WorkDocs
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method GetDocument on the
26             Amazon WorkDocs service. Use the attributes of this class
27             as arguments to method GetDocument.
28              
29             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocument.
30              
31             As an example:
32              
33             $service_obj->GetDocument(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 AuthenticationToken => Str
41              
42             Amazon WorkDocs authentication token. This field should not be set when
43             using administrative API actions, as in accessing the API using AWS
44             credentials.
45              
46              
47              
48             =head2 B<REQUIRED> DocumentId => Str
49              
50             The ID of the document.
51              
52              
53              
54             =head2 IncludeCustomMetadata => Bool
55              
56             Set this to C<TRUE> to include custom metadata in the response.
57              
58              
59              
60              
61             =head1 SEE ALSO
62              
63             This class forms part of L<Paws>, documenting arguments for method GetDocument in L<Paws::WorkDocs>
64              
65             =head1 BUGS and CONTRIBUTIONS
66              
67             The source code is located here: https://github.com/pplu/aws-sdk-perl
68              
69             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
70              
71             =cut
72