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

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 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::S3DataSourceConfiguration;
3 use Moose;
4 has AccessControlListConfiguration => (is => 'ro', isa => 'Paws::Kendra::AccessControlListConfiguration');
5 has BucketName => (is => 'ro', isa => 'Str', required => 1);
6 has DocumentsMetadataConfiguration => (is => 'ro', isa => 'Paws::Kendra::DocumentsMetadataConfiguration');
7 has ExclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has InclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
9 has InclusionPrefixes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::Kendra::S3DataSourceConfiguration
18  
19 =head1 USAGE
20  
21 This class represents one of two things:
22  
23 =head3 Arguments in a call to a service
24  
25 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
26 Each attribute should be used as a named argument in the calls that expect this type of object.
27  
28 As an example, if Att1 is expected to be a Paws::Kendra::S3DataSourceConfiguration object:
29  
30 $service_obj->Method(Att1 => { AccessControlListConfiguration => $value, ..., InclusionPrefixes => $value });
31  
32 =head3 Results returned from an API call
33  
34 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::S3DataSourceConfiguration object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->AccessControlListConfiguration
38  
39 =head1 DESCRIPTION
40  
41 Provides configuration information for a data source to index documents
42 in an Amazon S3 bucket.
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 AccessControlListConfiguration => L<Paws::Kendra::AccessControlListConfiguration>
48  
49 Provides the path to the S3 bucket that contains the user context
50 filtering files for the data source. For the format of the file, see
51 Access control for S3 data sources
52 (https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html).
53  
54  
55 =head2 B<REQUIRED> BucketName => Str
56  
57 The name of the bucket that contains the documents.
58  
59  
60 =head2 DocumentsMetadataConfiguration => L<Paws::Kendra::DocumentsMetadataConfiguration>
61  
62  
63  
64  
65 =head2 ExclusionPatterns => ArrayRef[Str|Undef]
66  
67 A list of glob patterns for documents that should not be indexed. If a
68 document that matches an inclusion prefix or inclusion pattern also
69 matches an exclusion pattern, the document is not indexed.
70  
71 Some examples
72 (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
73 are:
74  
75 =over
76  
77 =item *
78  
79 I<*.png , *.jpg> will exclude all PNG and JPEG image files in a
80 directory (files with the extensions .png and .jpg).
81  
82 =item *
83  
84 I<*internal*> will exclude all files in a directory that contain
85 'internal' in the file name, such as 'internal', 'internal_only',
86 'company_internal'.
87  
88 =item *
89  
90 I<**/*internal*> will exclude all internal-related files in a directory
91 and its subdirectories.
92  
93 =back
94  
95  
96  
97 =head2 InclusionPatterns => ArrayRef[Str|Undef]
98  
99 A list of glob patterns for documents that should be indexed. If a
100 document that matches an inclusion pattern also matches an exclusion
101 pattern, the document is not indexed.
102  
103 Some examples
104 (https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters)
105 are:
106  
107 =over
108  
109 =item *
110  
111 I<*.txt> will include all text files in a directory (files with the
112 extension .txt).
113  
114 =item *
115  
116 I<**/*.txt> will include all text files in a directory and its
117 subdirectories.
118  
119 =item *
120  
121 I<*tax*> will include all files in a directory that contain 'tax' in
122 the file name, such as 'tax', 'taxes', 'income_tax'.
123  
124 =back
125  
126  
127  
128 =head2 InclusionPrefixes => ArrayRef[Str|Undef]
129  
130 A list of S3 prefixes for the documents that should be included in the
131 index.
132  
133  
134  
135 =head1 SEE ALSO
136  
137 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
138  
139 =head1 BUGS and CONTRIBUTIONS
140  
141 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
142  
143 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
144  
145 =cut
146