blib/lib/Paws/Kendra/ServiceNowKnowledgeArticleConfiguration.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::ServiceNowKnowledgeArticleConfiguration;
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 FilterQuery => (is => 'ro', isa => 'Str');
10 has IncludeAttachmentFilePatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
11  
12 1;
13  
14 ### main pod documentation begin ###
15  
16 =head1 NAME
17  
18 Paws::Kendra::ServiceNowKnowledgeArticleConfiguration
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::ServiceNowKnowledgeArticleConfiguration object:
30  
31 $service_obj->Method(Att1 => { CrawlAttachments => $value, ..., IncludeAttachmentFilePatterns => $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::ServiceNowKnowledgeArticleConfiguration object:
36  
37 $result = $service_obj->Method(...);
38 $result->Att1->CrawlAttachments
39  
40 =head1 DESCRIPTION
41  
42 Provides configuration information for crawling knowledge articles in
43 the ServiceNow site.
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 CrawlAttachments => Bool
49  
50 Indicates whether Amazon Kendra should index attachments to knowledge
51 articles.
52  
53  
54 =head2 B<REQUIRED> DocumentDataFieldName => Str
55  
56 The name of the ServiceNow field that is mapped to the index document
57 contents field in the Amazon Kendra index.
58  
59  
60 =head2 DocumentTitleFieldName => Str
61  
62 The name of the ServiceNow field that is mapped to the index document
63 title field.
64  
65  
66 =head2 ExcludeAttachmentFilePatterns => ArrayRef[Str|Undef]
67  
68 List of regular expressions applied to knowledge articles. Items that
69 don't match the inclusion pattern are not indexed. The regex is applied
70 to the field specified in the C<PatternTargetField>
71  
72  
73 =head2 FieldMappings => ArrayRef[L<Paws::Kendra::DataSourceToIndexFieldMapping>]
74  
75 Mapping between ServiceNow fields and Amazon Kendra index fields. You
76 must create the index field before you map the field.
77  
78  
79 =head2 FilterQuery => Str
80  
81 A query that selects the knowledge articles to index. The query can
82 return articles from multiple knowledge bases, and the knowledge bases
83 can be public or private.
84  
85 The query string must be one generated by the ServiceNow console. For
86 more information, see Specifying documents to index with a query
87 (https://docs.aws.amazon.com/kendra/latest/dg/servicenow-query.html).
88  
89  
90 =head2 IncludeAttachmentFilePatterns => ArrayRef[Str|Undef]
91  
92 List of regular expressions applied to knowledge articles. Items that
93 don't match the inclusion pattern are not indexed. The regex is applied
94 to the field specified in the C<PatternTargetField>.
95  
96  
97  
98 =head1 SEE ALSO
99  
100 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
101  
102 =head1 BUGS and CONTRIBUTIONS
103  
104 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
105  
106 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
107  
108 =cut
109