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

filter: Statementstmt 0.0% 0 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 16 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::SharePointConfiguration;
3 use Moose;
4 has CrawlAttachments => (is => 'ro', isa => 'Bool');
5 has DisableLocalGroups => (is => 'ro', isa => 'Bool');
6 has DocumentTitleFieldName => (is => 'ro', isa => 'Str');
7 has ExclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has FieldMappings => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::DataSourceToIndexFieldMapping]');
9 has InclusionPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
10 has SecretArn => (is => 'ro', isa => 'Str', required => 1);
11 has SharePointVersion => (is => 'ro', isa => 'Str', required => 1);
12 has SslCertificateS3Path => (is => 'ro', isa => 'Paws::Kendra::S3Path');
13 has Urls => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1);
14 has UseChangeLog => (is => 'ro', isa => 'Bool');
15 has VpcConfiguration => (is => 'ro', isa => 'Paws::Kendra::DataSourceVpcConfiguration');
16  
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Kendra::SharePointConfiguration
24  
25 =head1 USAGE
26  
27 This class represents one of two things:
28  
29 =head3 Arguments in a call to a service
30  
31 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32 Each attribute should be used as a named argument in the calls that expect this type of object.
33  
34 As an example, if Att1 is expected to be a Paws::Kendra::SharePointConfiguration object:
35  
36 $service_obj->Method(Att1 => { CrawlAttachments => $value, ..., VpcConfiguration => $value });
37  
38 =head3 Results returned from an API call
39  
40 Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::SharePointConfiguration object:
41  
42 $result = $service_obj->Method(...);
43 $result->Att1->CrawlAttachments
44  
45 =head1 DESCRIPTION
46  
47 Provides configuration information for connecting to a Microsoft
48 SharePoint data source.
49  
50 =head1 ATTRIBUTES
51  
52  
53 =head2 CrawlAttachments => Bool
54  
55 C<TRUE> to include attachments to documents stored in your Microsoft
56 SharePoint site in the index; otherwise, C<FALSE>.
57  
58  
59 =head2 DisableLocalGroups => Bool
60  
61 A Boolean value that specifies whether local groups are disabled
62 (C<True>) or enabled (C<False>).
63  
64  
65 =head2 DocumentTitleFieldName => Str
66  
67 The Microsoft SharePoint attribute field that contains the title of the
68 document.
69  
70  
71 =head2 ExclusionPatterns => ArrayRef[Str|Undef]
72  
73 A list of regular expression patterns. Documents that match the
74 patterns are excluded from the index. Documents that don't match the
75 patterns are included in the index. If a document matches both an
76 exclusion pattern and an inclusion pattern, the document is not
77 included in the index.
78  
79 The regex is applied to the display URL of the SharePoint document.
80  
81  
82 =head2 FieldMappings => ArrayRef[L<Paws::Kendra::DataSourceToIndexFieldMapping>]
83  
84 A list of C<DataSourceToIndexFieldMapping> objects that map Microsoft
85 SharePoint attributes to custom fields in the Amazon Kendra index. You
86 must first create the index fields using the C<UpdateIndex> operation
87 before you map SharePoint attributes. For more information, see Mapping
88 Data Source Fields
89 (https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html).
90  
91  
92 =head2 InclusionPatterns => ArrayRef[Str|Undef]
93  
94 A list of regular expression patterns. Documents that match the
95 patterns are included in the index. Documents that don't match the
96 patterns are excluded from the index. If a document matches both an
97 inclusion pattern and an exclusion pattern, the document is not
98 included in the index.
99  
100 The regex is applied to the display URL of the SharePoint document.
101  
102  
103 =head2 B<REQUIRED> SecretArn => Str
104  
105 The Amazon Resource Name (ARN) of credentials stored in AWS Secrets
106 Manager. The credentials should be a user/password pair. For more
107 information, see Using a Microsoft SharePoint Data Source
108 (https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html).
109 For more information about AWS Secrets Manager, see What Is AWS Secrets
110 Manager
111 (https://docs.aws.amazon.com/secretsmanager/latest/userguide/intro.html)
112 in the I<AWS Secrets Manager> user guide.
113  
114  
115 =head2 B<REQUIRED> SharePointVersion => Str
116  
117 The version of Microsoft SharePoint that you are using as a data
118 source.
119  
120  
121 =head2 SslCertificateS3Path => L<Paws::Kendra::S3Path>
122  
123  
124  
125  
126 =head2 B<REQUIRED> Urls => ArrayRef[Str|Undef]
127  
128 The URLs of the Microsoft SharePoint site that contains the documents
129 that should be indexed.
130  
131  
132 =head2 UseChangeLog => Bool
133  
134 Set to C<TRUE> to use the Microsoft SharePoint change log to determine
135 the documents that need to be updated in the index. Depending on the
136 size of the SharePoint change log, it may take longer for Amazon Kendra
137 to use the change log than it takes it to determine the changed
138 documents using the Amazon Kendra document crawler.
139  
140  
141 =head2 VpcConfiguration => L<Paws::Kendra::DataSourceVpcConfiguration>
142  
143  
144  
145  
146  
147 =head1 SEE ALSO
148  
149 This class forms part of L<Paws>, describing an object used in L<Paws::Kendra>
150  
151 =head1 BUGS and CONTRIBUTIONS
152  
153 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
154  
155 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
156  
157 =cut
158