« blib/lib/Paws/Kendra/ColumnConfiguration.pm
↑ Summary
blib/lib/Paws/Kendra/ConfluenceAttachmentToIndexFieldMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ConfluenceAttachmentConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has AttachmentFieldMappings => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::ConfluenceAttachmentToIndexFieldMapping]'); | ||
| 5 | has CrawlAttachments => (is => 'ro', isa => 'Bool'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Kendra::ConfluenceAttachmentConfiguration | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Kendra::ConfluenceAttachmentConfiguration object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { AttachmentFieldMappings => $value, ..., CrawlAttachments => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConfluenceAttachmentConfiguration object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->AttachmentFieldMappings | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Specifies the attachment settings for the Confluence data source. | ||
| 38 | Attachment settings are optional, if you don't specify settings | ||
| 39 | attachments, Amazon Kendra won't index them. | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 AttachmentFieldMappings => ArrayRef[L<Paws::Kendra::ConfluenceAttachmentToIndexFieldMapping>] | ||
| 45 | |||
| 46 | Defines how attachment metadata fields should be mapped to index | ||
| 47 | fields. Before you can map a field, you must first create an index | ||
| 48 | field with a matching type using the console or the C<UpdateIndex> | ||
| 49 | operation. | ||
| 50 | |||
| 51 | If you specify the C<AttachentFieldMappings> parameter, you must | ||
| 52 | specify at least one field mapping. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CrawlAttachments => Bool | ||
| 56 | |||
| 57 | Indicates whether Amazon Kendra indexes attachments to the pages and | ||
| 58 | blogs in the Confluence data source. | ||
| 59 | |||
| 60 | |||
| 61 | |||
| 62 | =head1 SEE ALSO | ||
| 63 | |||
| 64 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 65 | |||
| 66 | =head1 BUGS and CONTRIBUTIONS | ||
| 67 | |||
| 68 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 69 | |||
| 70 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 71 | |||
| 72 | =cut | ||
| 73 |