| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::GoogleDriveConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ExcludeMimeTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has ExcludeSharedDrives => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | has ExcludeUserAccounts => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 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 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Kendra::GoogleDriveConfiguration | ||
| 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::GoogleDriveConfiguration object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { ExcludeMimeTypes => $value, ..., SecretArn => $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::GoogleDriveConfiguration object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->ExcludeMimeTypes | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Provides configuration information for data sources that connect to | ||
| 43 | Google Drive. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 ExcludeMimeTypes => ArrayRef[Str|Undef] | ||
| 49 | |||
| 50 | A list of MIME types to exclude from the index. All documents matching | ||
| 51 | the specified MIME type are excluded. | ||
| 52 | |||
| 53 | For a list of MIME types, see Using a Google Workspace Drive data | ||
| 54 | source | ||
| 55 | (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ExcludeSharedDrives => ArrayRef[Str|Undef] | ||
| 59 | |||
| 60 | A list of identifiers or shared drives to exclude from the index. All | ||
| 61 | files and folders stored on the shared drive are excluded. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 ExcludeUserAccounts => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | A list of email addresses of the users. Documents owned by these users | ||
| 67 | are excluded from the index. Documents shared with excluded users are | ||
| 68 | indexed unless they are excluded in another way. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ExclusionPatterns => ArrayRef[Str|Undef] | ||
| 72 | |||
| 73 | A list of regular expression patterns that apply to the path on Google | ||
| 74 | Drive. Items that match the pattern are excluded from the index from | ||
| 75 | both shared drives and users' My Drives. Items that don't match the | ||
| 76 | pattern are included in the index. If an item matches both an exclusion | ||
| 77 | pattern and an inclusion pattern, it is excluded from the index. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 FieldMappings => ArrayRef[L<Paws::Kendra::DataSourceToIndexFieldMapping>] | ||
| 81 | |||
| 82 | Defines mapping between a field in the Google Drive and a Amazon Kendra | ||
| 83 | index field. | ||
| 84 | |||
| 85 | If you are using the console, you can define index fields when creating | ||
| 86 | the mapping. If you are using the API, you must first create the field | ||
| 87 | using the C<UpdateIndex> operation. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 InclusionPatterns => ArrayRef[Str|Undef] | ||
| 91 | |||
| 92 | A list of regular expression patterns that apply to path on Google | ||
| 93 | Drive. Items that match the pattern are included in the index from both | ||
| 94 | shared drives and users' My Drives. Items that don't match the pattern | ||
| 95 | are excluded from the index. If an item matches both an inclusion | ||
| 96 | pattern and an exclusion pattern, it is excluded from the index. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> SecretArn => Str | ||
| 100 | |||
| 101 | The Amazon Resource Name (ARN) of a AWS Secrets Manager secret that | ||
| 102 | contains the credentials required to connect to Google Drive. For more | ||
| 103 | information, see Using a Google Workspace Drive data source | ||
| 104 | (https://docs.aws.amazon.com/kendra/latest/dg/data-source-google-drive.html). | ||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |