« blib/lib/Paws/Kendra/SalesforceChatterFeedConfiguration.pm
↑ Summary
blib/lib/Paws/Kendra/SalesforceCustomKnowledgeArticleTypeConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::SalesforceConfiguration; | ||
| 3 | use Moose; | ||
| 4 | has ChatterFeedConfiguration => (is => 'ro', isa => 'Paws::Kendra::SalesforceChatterFeedConfiguration'); | ||
| 5 | has CrawlAttachments => (is => 'ro', isa => 'Bool'); | ||
| 6 | has ExcludeAttachmentFilePatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has IncludeAttachmentFilePatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 8 | has KnowledgeArticleConfiguration => (is => 'ro', isa => 'Paws::Kendra::SalesforceKnowledgeArticleConfiguration'); | ||
| 9 | has SecretArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has ServerUrl => (is => 'ro', isa => 'Str', required => 1); | ||
| 11 | has StandardObjectAttachmentConfiguration => (is => 'ro', isa => 'Paws::Kendra::SalesforceStandardObjectAttachmentConfiguration'); | ||
| 12 | has StandardObjectConfigurations => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::SalesforceStandardObjectConfiguration]'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Kendra::SalesforceConfiguration | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::Kendra::SalesforceConfiguration object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { ChatterFeedConfiguration => $value, ..., StandardObjectConfigurations => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::SalesforceConfiguration object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->ChatterFeedConfiguration | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Provides configuration information for connecting to a Salesforce data | ||
| 45 | source. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ChatterFeedConfiguration => L<Paws::Kendra::SalesforceChatterFeedConfiguration> | ||
| 51 | |||
| 52 | Specifies configuration information for Salesforce chatter feeds. | ||
| 53 | |||
| 54 | |||
| 55 | =head2 CrawlAttachments => Bool | ||
| 56 | |||
| 57 | Indicates whether Amazon Kendra should index attachments to Salesforce | ||
| 58 | objects. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 ExcludeAttachmentFilePatterns => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | A list of regular expression patterns. Documents that match the | ||
| 64 | patterns are excluded from the index. Documents that don't match the | ||
| 65 | patterns are included in the index. If a document matches both an | ||
| 66 | exclusion pattern and an inclusion pattern, the document is not | ||
| 67 | included in the index. | ||
| 68 | |||
| 69 | The regex is applied to the name of the attached file. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 IncludeAttachmentFilePatterns => ArrayRef[Str|Undef] | ||
| 73 | |||
| 74 | A list of regular expression patterns. Documents that match the | ||
| 75 | patterns are included in the index. Documents that don't match the | ||
| 76 | patterns are excluded from the index. If a document matches both an | ||
| 77 | inclusion pattern and an exclusion pattern, the document is not | ||
| 78 | included in the index. | ||
| 79 | |||
| 80 | The regex is applied to the name of the attached file. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 KnowledgeArticleConfiguration => L<Paws::Kendra::SalesforceKnowledgeArticleConfiguration> | ||
| 84 | |||
| 85 | Specifies configuration information for the knowledge article types | ||
| 86 | that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge | ||
| 87 | articles and the standard fields of knowledge articles, or the custom | ||
| 88 | fields of custom knowledge articles, but not both. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 B<REQUIRED> SecretArn => Str | ||
| 92 | |||
| 93 | The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that | ||
| 94 | contains the key/value pairs required to connect to your Salesforce | ||
| 95 | instance. The secret must contain a JSON structure with the following | ||
| 96 | keys: | ||
| 97 | |||
| 98 | =over | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to | ||
| 103 | get an OAUTH token. | ||
| 104 | |||
| 105 | =item * | ||
| 106 | |||
| 107 | consumerKey - The application public key generated when you created | ||
| 108 | your Salesforce application. | ||
| 109 | |||
| 110 | =item * | ||
| 111 | |||
| 112 | consumerSecret - The application private key generated when you created | ||
| 113 | your Salesforce application. | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | password - The password associated with the user logging in to the | ||
| 118 | Salesforce instance. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | securityToken - The token associated with the user account logging in | ||
| 123 | to the Salesforce instance. | ||
| 124 | |||
| 125 | =item * | ||
| 126 | |||
| 127 | username - The user name of the user logging in to the Salesforce | ||
| 128 | instance. | ||
| 129 | |||
| 130 | =back | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head2 B<REQUIRED> ServerUrl => Str | ||
| 135 | |||
| 136 | The instance URL for the Salesforce site that you want to index. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 StandardObjectAttachmentConfiguration => L<Paws::Kendra::SalesforceStandardObjectAttachmentConfiguration> | ||
| 140 | |||
| 141 | Provides configuration information for processing attachments to | ||
| 142 | Salesforce standard objects. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 StandardObjectConfigurations => ArrayRef[L<Paws::Kendra::SalesforceStandardObjectConfiguration>] | ||
| 146 | |||
| 147 | Specifies the Salesforce standard objects that Amazon Kendra indexes. | ||
| 148 | |||
| 149 | |||
| 150 | |||
| 151 | =head1 SEE ALSO | ||
| 152 | |||
| 153 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 154 | |||
| 155 | =head1 BUGS and CONTRIBUTIONS | ||
| 156 | |||
| 157 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 158 | |||
| 159 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 160 | |||
| 161 | =cut | ||
| 162 |