blib/lib/Paws/Kendra/ServiceNowServiceCatalogConfiguration.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::ServiceNowServiceCatalogConfiguration;
3 use Moose;
4 has CrawlAttachments => (is => 'ro', isa => 'Bool');
5 has DocumentDataFieldName => (is => 'ro', isa => 'Str', required => 1);
6 has DocumentTitleFieldName => (is => 'ro', isa => 'Str');
7 has ExcludeAttachmentFilePatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has FieldMappings => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DataSourceToIndexFieldMapping]');
9 has IncludeAttachmentFilePatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10  
11 1;
12  
13 ### main pod documentation begin ###
14  
15 =head1 NAME
16  
17 Paws::Kendra::ServiceNowServiceCatalogConfiguration
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::ServiceNowServiceCatalogConfiguration object:
29  
30 $service_obj->Method(Att1 => { CrawlAttachments => $value, ..., IncludeAttachmentFilePatterns => $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::ServiceNowServiceCatalogConfiguration object:
35  
36 $result = $service_obj->Method(...);
37 $result->Att1->CrawlAttachments
38  
39 =head1 DESCRIPTION
40  
41 Provides configuration information for crawling service catalog items
42 in the ServiceNow site
43  
44 =head1 ATTRIBUTES
45  
46  
47 =head2 CrawlAttachments => Bool
48  
49 Indicates whether Amazon Kendra should crawl attachments to the service
50 catalog items.
51  
52  
53 =head2 B<REQUIRED> DocumentDataFieldName => Str
54  
55 The name of the ServiceNow field that is mapped to the index document
56 contents field in the Amazon Kendra index.
57  
58  
59 =head2 DocumentTitleFieldName => Str
60  
61 The name of the ServiceNow field that is mapped to the index document
62 title field.
63  
64  
65 =head2 ExcludeAttachmentFilePatterns => ArrayRef[Str|Undef]
66  
67 A list of regular expression patterns. Documents that match the
68 patterns are excluded from the index. Documents that don't match the
69 patterns are included in the index. If a document matches both an
70 exclusion pattern and an inclusion pattern, the document is not
71 included in the index.
72  
73 The regex is applied to the file name of the attachment.
74  
75  
76 =head2 FieldMappings => ArrayRef[L<Paws::Kendra::DataSourceToIndexFieldMapping>]
77  
78 Mapping between ServiceNow fields and Amazon Kendra index fields. You
79 must create the index field before you map the field.
80  
81  
82 =head2 IncludeAttachmentFilePatterns => ArrayRef[Str|Undef]
83  
84 A list of regular expression patterns. Documents that match the
85 patterns are included in the index. Documents that don't match the
86 patterns are excluded from the index. If a document matches both an
87 exclusion pattern and an inclusion pattern, the document is not
88 included in the index.
89  
90 The regex is applied to the file name of the attachment.
91  
92  
93  
94 =head1 SEE ALSO
95  
96 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
97  
98 =head1 BUGS and CONTRIBUTIONS
99  
100 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
101  
102 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
103  
104 =cut
105