blib/lib/Paws/Kendra/Document.pm untested

filter: Statementstmt 0.0% 0 / 10 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 11 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Kendra::Document;
3 use Moose;
4 has AccessControlList => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::Principal]');
5 has Attributes => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DocumentAttribute]');
6 has Blob => (is => 'ro', isa => 'Str');
7 has ContentType => (is => 'ro', isa => 'Str');
8 has Id => (is => 'ro', isa => 'Str', required => 1);
9 has S3Path => (is => 'ro', isa => 'Paws::Kendra::S3Path');
10 has Title => (is => 'ro', isa => 'Str');
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::Kendra::Document
19  
20 =head1 USAGE
21  
22 This class represents one of two things:
23  
24 =head3 Arguments in a call to a service
25  
26 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27 Each attribute should be used as a named argument in the calls that expect this type of object.
28  
29 As an example, if Att1 is expected to be a Paws::Kendra::Document object:
30  
31 $service_obj->Method(Att1 => { AccessControlList => $value, ..., Title => $value });
32  
33 =head3 Results returned from an API call
34  
35 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::Document object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->AccessControlList
39  
40 =head1 DESCRIPTION
41  
42 A document in an index.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 AccessControlList => ArrayRef[L<Paws::Kendra::Principal>]
48  
49 Information to use for user context filtering.
50  
51  
52 =head2 Attributes => ArrayRef[L<Paws::Kendra::DocumentAttribute>]
53  
54 Custom attributes to apply to the document. Use the custom attributes
55 to provide additional information for searching, to provide facets for
56 refining searches, and to provide additional information in the query
57 response.
58  
59  
60 =head2 Blob => Str
61  
62 The contents of the document.
63  
64 Documents passed to the C<Blob> parameter must be base64 encoded. Your
65 code might not need to encode the document file bytes if you're using
66 an AWS SDK to call Amazon Kendra operations. If you are calling the
67 Amazon Kendra endpoint directly using REST, you must base64 encode the
68 contents before sending.
69  
70  
71 =head2 ContentType => Str
72  
73 The file type of the document in the C<Blob> field.
74  
75  
76 =head2 B<REQUIRED> Id => Str
77  
78 A unique identifier of the document in the index.
79  
80  
81 =head2 S3Path => L<Paws::Kendra::S3Path>
82  
83  
84  
85  
86 =head2 Title => Str
87  
88 The title of the document.
89  
90  
91  
92 =head1 SEE ALSO
93  
94 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
95  
96 =head1 BUGS and CONTRIBUTIONS
97  
98 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
99  
100 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
101  
102 =cut
103