« blib/lib/Paws/Kendra/ConfluencePageToIndexFieldMapping.pm
↑ Summary
blib/lib/Paws/Kendra/ConfluenceSpaceToIndexFieldMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::ConfluenceSpaceConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has CrawlArchivedSpaces => (is => 'ro', isa => 'Bool'); | ||
| 5 | has CrawlPersonalSpaces => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ExcludeSpaces => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has IncludeSpaces => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has SpaceFieldMappings => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::ConfluenceSpaceToIndexFieldMapping]'); | ||
| 9 | |||
| 10 | 1; | ||
| 11 | |||
| 12 | ### main pod documentation begin ### | ||
| 13 | |||
| 14 | =head1 NAME | ||
| 15 | |||
| 16 | Paws::Kendra::ConfluenceSpaceConfiguration | ||
| 17 | |||
| 18 | =head1 USAGE | ||
| 19 | |||
| 20 | This class represents one of two things: | ||
| 21 | |||
| 22 | =head3 Arguments in a call to a service | ||
| 23 | |||
| 24 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 25 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 26 | |||
| 27 | As an example, if Att1 is expected to be a Paws::Kendra::ConfluenceSpaceConfiguration object: | ||
| 28 | |||
| 29 | $service_obj->Method(Att1 => { CrawlArchivedSpaces => $value, ..., SpaceFieldMappings => $value }); | ||
| 30 | |||
| 31 | =head3 Results returned from an API call | ||
| 32 | |||
| 33 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::ConfluenceSpaceConfiguration object: | ||
| 34 | |||
| 35 | $result = $service_obj->Method(...); | ||
| 36 | $result->Att1->CrawlArchivedSpaces | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | Specifies the configuration for indexing Confluence spaces. | ||
| 41 | |||
| 42 | =head1 ATTRIBUTES | ||
| 43 | |||
| 44 | |||
| 45 | =head2 CrawlArchivedSpaces => Bool | ||
| 46 | |||
| 47 | Specifies whether Amazon Kendra should index archived spaces. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 CrawlPersonalSpaces => Bool | ||
| 51 | |||
| 52 | Specifies whether Amazon Kendra should index personal spaces. Users can | ||
| 53 | add restrictions to items in personal spaces. If personal spaces are | ||
| 54 | indexed, queries without user context information may return restricted | ||
| 55 | items from a personal space in their results. For more information, see | ||
| 56 | Filtering on user context | ||
| 57 | (https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html). | ||
| 58 | |||
| 59 | |||
| 60 | =head2 ExcludeSpaces => ArrayRef[Str|Undef] | ||
| 61 | |||
| 62 | A list of space keys of Confluence spaces. If you include a key, the | ||
| 63 | blogs, documents, and attachments in the space are not indexed. If a | ||
| 64 | space is in both the C<ExcludeSpaces> and the C<IncludeSpaces> list, | ||
| 65 | the space is excluded. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 IncludeSpaces => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | A list of space keys for Confluence spaces. If you include a key, the | ||
| 71 | blogs, documents, and attachments in the space are indexed. Spaces that | ||
| 72 | aren't in the list aren't indexed. A space in the list must exist. | ||
| 73 | Otherwise, Amazon Kendra logs an error when the data source is | ||
| 74 | synchronized. If a space is in both the C<IncludeSpaces> and the | ||
| 75 | C<ExcludeSpaces> list, the space is excluded. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 SpaceFieldMappings => ArrayRef[L<Paws::Kendra::ConfluenceSpaceToIndexFieldMapping>] | ||
| 79 | |||
| 80 | Defines how space metadata fields should be mapped to index fields. | ||
| 81 | Before you can map a field, you must first create an index field with a | ||
| 82 | matching type using the console or the C<UpdateIndex> operation. | ||
| 83 | |||
| 84 | If you specify the C<SpaceFieldMappings> parameter, you must specify at | ||
| 85 | least one field mapping. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | =head1 SEE ALSO | ||
| 90 | |||
| 91 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 92 | |||
| 93 | =head1 BUGS and CONTRIBUTIONS | ||
| 94 | |||
| 95 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 96 | |||
| 97 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 98 | |||
| 99 | =cut | ||
| 100 |