« blib/lib/Paws/Kendra/ConfluencePageConfiguration.pm
↑ Summary
blib/lib/Paws/Kendra/ConfluenceSpaceConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ConfluencePageToIndexFieldMapping; | ||
| 3 | use Moose; | ||
| 4 | has DataSourceFieldName => (is => 'ro', isa => 'Str'); | ||
| 5 | has DateFieldFormat => (is => 'ro', isa => 'Str'); | ||
| 6 | has IndexFieldName => (is => 'ro', isa => 'Str'); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Kendra::ConfluencePageToIndexFieldMapping | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Kendra::ConfluencePageToIndexFieldMapping object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { DataSourceFieldName => $value, ..., IndexFieldName => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConfluencePageToIndexFieldMapping object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->DataSourceFieldName | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Defines the mapping between a field in the Confluence data source to a | ||
| 39 | Amazon Kendra index field. | ||
| 40 | |||
| 41 | You must first create the index field using the C<UpdateIndex> | ||
| 42 | operation. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 DataSourceFieldName => Str | ||
| 48 | |||
| 49 | The name of the field in the data source. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 DateFieldFormat => Str | ||
| 53 | |||
| 54 | The format for date fields in the data source. If the field specified | ||
| 55 | in C<DataSourceFieldName> is a date field you must specify the date | ||
| 56 | format. If the field is not a date field, an exception is thrown. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 IndexFieldName => Str | ||
| 60 | |||
| 61 | The name of the index field to map to the Confluence data source field. | ||
| 62 | The index field type must match the Confluence field type. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head1 SEE ALSO | ||
| 67 | |||
| 68 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 69 | |||
| 70 | =head1 BUGS and CONTRIBUTIONS | ||
| 71 | |||
| 72 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 73 | |||
| 74 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 75 | |||
| 76 | =cut | ||
| 77 |