AWS SDK for C++  1.9.1
AWS SDK for C++
Public Member Functions | List of all members
Aws::kendra::Model::SalesforceConfiguration Class Reference

#include <SalesforceConfiguration.h>

Public Member Functions

 SalesforceConfiguration ()
 
 SalesforceConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
SalesforceConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetServerUrl () const
 
bool ServerUrlHasBeenSet () const
 
void SetServerUrl (const Aws::String &value)
 
void SetServerUrl (Aws::String &&value)
 
void SetServerUrl (const char *value)
 
SalesforceConfigurationWithServerUrl (const Aws::String &value)
 
SalesforceConfigurationWithServerUrl (Aws::String &&value)
 
SalesforceConfigurationWithServerUrl (const char *value)
 
const Aws::StringGetSecretArn () const
 
bool SecretArnHasBeenSet () const
 
void SetSecretArn (const Aws::String &value)
 
void SetSecretArn (Aws::String &&value)
 
void SetSecretArn (const char *value)
 
SalesforceConfigurationWithSecretArn (const Aws::String &value)
 
SalesforceConfigurationWithSecretArn (Aws::String &&value)
 
SalesforceConfigurationWithSecretArn (const char *value)
 
const Aws::Vector< SalesforceStandardObjectConfiguration > & GetStandardObjectConfigurations () const
 
bool StandardObjectConfigurationsHasBeenSet () const
 
void SetStandardObjectConfigurations (const Aws::Vector< SalesforceStandardObjectConfiguration > &value)
 
void SetStandardObjectConfigurations (Aws::Vector< SalesforceStandardObjectConfiguration > &&value)
 
SalesforceConfigurationWithStandardObjectConfigurations (const Aws::Vector< SalesforceStandardObjectConfiguration > &value)
 
SalesforceConfigurationWithStandardObjectConfigurations (Aws::Vector< SalesforceStandardObjectConfiguration > &&value)
 
SalesforceConfigurationAddStandardObjectConfigurations (const SalesforceStandardObjectConfiguration &value)
 
SalesforceConfigurationAddStandardObjectConfigurations (SalesforceStandardObjectConfiguration &&value)
 
const SalesforceKnowledgeArticleConfigurationGetKnowledgeArticleConfiguration () const
 
bool KnowledgeArticleConfigurationHasBeenSet () const
 
void SetKnowledgeArticleConfiguration (const SalesforceKnowledgeArticleConfiguration &value)
 
void SetKnowledgeArticleConfiguration (SalesforceKnowledgeArticleConfiguration &&value)
 
SalesforceConfigurationWithKnowledgeArticleConfiguration (const SalesforceKnowledgeArticleConfiguration &value)
 
SalesforceConfigurationWithKnowledgeArticleConfiguration (SalesforceKnowledgeArticleConfiguration &&value)
 
const SalesforceChatterFeedConfigurationGetChatterFeedConfiguration () const
 
bool ChatterFeedConfigurationHasBeenSet () const
 
void SetChatterFeedConfiguration (const SalesforceChatterFeedConfiguration &value)
 
void SetChatterFeedConfiguration (SalesforceChatterFeedConfiguration &&value)
 
SalesforceConfigurationWithChatterFeedConfiguration (const SalesforceChatterFeedConfiguration &value)
 
SalesforceConfigurationWithChatterFeedConfiguration (SalesforceChatterFeedConfiguration &&value)
 
bool GetCrawlAttachments () const
 
bool CrawlAttachmentsHasBeenSet () const
 
void SetCrawlAttachments (bool value)
 
SalesforceConfigurationWithCrawlAttachments (bool value)
 
const SalesforceStandardObjectAttachmentConfigurationGetStandardObjectAttachmentConfiguration () const
 
bool StandardObjectAttachmentConfigurationHasBeenSet () const
 
void SetStandardObjectAttachmentConfiguration (const SalesforceStandardObjectAttachmentConfiguration &value)
 
void SetStandardObjectAttachmentConfiguration (SalesforceStandardObjectAttachmentConfiguration &&value)
 
SalesforceConfigurationWithStandardObjectAttachmentConfiguration (const SalesforceStandardObjectAttachmentConfiguration &value)
 
SalesforceConfigurationWithStandardObjectAttachmentConfiguration (SalesforceStandardObjectAttachmentConfiguration &&value)
 
const Aws::Vector< Aws::String > & GetIncludeAttachmentFilePatterns () const
 
bool IncludeAttachmentFilePatternsHasBeenSet () const
 
void SetIncludeAttachmentFilePatterns (const Aws::Vector< Aws::String > &value)
 
void SetIncludeAttachmentFilePatterns (Aws::Vector< Aws::String > &&value)
 
SalesforceConfigurationWithIncludeAttachmentFilePatterns (const Aws::Vector< Aws::String > &value)
 
SalesforceConfigurationWithIncludeAttachmentFilePatterns (Aws::Vector< Aws::String > &&value)
 
SalesforceConfigurationAddIncludeAttachmentFilePatterns (const Aws::String &value)
 
SalesforceConfigurationAddIncludeAttachmentFilePatterns (Aws::String &&value)
 
SalesforceConfigurationAddIncludeAttachmentFilePatterns (const char *value)
 
const Aws::Vector< Aws::String > & GetExcludeAttachmentFilePatterns () const
 
bool ExcludeAttachmentFilePatternsHasBeenSet () const
 
void SetExcludeAttachmentFilePatterns (const Aws::Vector< Aws::String > &value)
 
void SetExcludeAttachmentFilePatterns (Aws::Vector< Aws::String > &&value)
 
SalesforceConfigurationWithExcludeAttachmentFilePatterns (const Aws::Vector< Aws::String > &value)
 
SalesforceConfigurationWithExcludeAttachmentFilePatterns (Aws::Vector< Aws::String > &&value)
 
SalesforceConfigurationAddExcludeAttachmentFilePatterns (const Aws::String &value)
 
SalesforceConfigurationAddExcludeAttachmentFilePatterns (Aws::String &&value)
 
SalesforceConfigurationAddExcludeAttachmentFilePatterns (const char *value)
 

Detailed Description

Provides configuration information for connecting to a Salesforce data source.

See Also:

AWS API Reference

Definition at line 37 of file SalesforceConfiguration.h.

Constructor & Destructor Documentation

◆ SalesforceConfiguration() [1/2]

Aws::kendra::Model::SalesforceConfiguration::SalesforceConfiguration ( )

◆ SalesforceConfiguration() [2/2]

Aws::kendra::Model::SalesforceConfiguration::SalesforceConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddExcludeAttachmentFilePatterns() [1/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddExcludeAttachmentFilePatterns ( Aws::String &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 551 of file SalesforceConfiguration.h.

◆ AddExcludeAttachmentFilePatterns() [2/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddExcludeAttachmentFilePatterns ( const Aws::String value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 542 of file SalesforceConfiguration.h.

◆ AddExcludeAttachmentFilePatterns() [3/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddExcludeAttachmentFilePatterns ( const char *  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 560 of file SalesforceConfiguration.h.

◆ AddIncludeAttachmentFilePatterns() [1/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddIncludeAttachmentFilePatterns ( Aws::String &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 469 of file SalesforceConfiguration.h.

◆ AddIncludeAttachmentFilePatterns() [2/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddIncludeAttachmentFilePatterns ( const Aws::String value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 460 of file SalesforceConfiguration.h.

◆ AddIncludeAttachmentFilePatterns() [3/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddIncludeAttachmentFilePatterns ( const char *  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 478 of file SalesforceConfiguration.h.

◆ AddStandardObjectConfigurations() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddStandardObjectConfigurations ( const SalesforceStandardObjectConfiguration value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 249 of file SalesforceConfiguration.h.

◆ AddStandardObjectConfigurations() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::AddStandardObjectConfigurations ( SalesforceStandardObjectConfiguration &&  value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 254 of file SalesforceConfiguration.h.

◆ ChatterFeedConfigurationHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::ChatterFeedConfigurationHasBeenSet ( ) const
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 314 of file SalesforceConfiguration.h.

◆ CrawlAttachmentsHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::CrawlAttachmentsHasBeenSet ( ) const
inline

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Definition at line 347 of file SalesforceConfiguration.h.

◆ ExcludeAttachmentFilePatternsHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::ExcludeAttachmentFilePatternsHasBeenSet ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 497 of file SalesforceConfiguration.h.

◆ GetChatterFeedConfiguration()

const SalesforceChatterFeedConfiguration& Aws::kendra::Model::SalesforceConfiguration::GetChatterFeedConfiguration ( ) const
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 309 of file SalesforceConfiguration.h.

◆ GetCrawlAttachments()

bool Aws::kendra::Model::SalesforceConfiguration::GetCrawlAttachments ( ) const
inline

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Definition at line 341 of file SalesforceConfiguration.h.

◆ GetExcludeAttachmentFilePatterns()

const Aws::Vector<Aws::String>& Aws::kendra::Model::SalesforceConfiguration::GetExcludeAttachmentFilePatterns ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 488 of file SalesforceConfiguration.h.

◆ GetIncludeAttachmentFilePatterns()

const Aws::Vector<Aws::String>& Aws::kendra::Model::SalesforceConfiguration::GetIncludeAttachmentFilePatterns ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 406 of file SalesforceConfiguration.h.

◆ GetKnowledgeArticleConfiguration()

const SalesforceKnowledgeArticleConfiguration& Aws::kendra::Model::SalesforceConfiguration::GetKnowledgeArticleConfiguration ( ) const
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 263 of file SalesforceConfiguration.h.

◆ GetSecretArn()

const Aws::String& Aws::kendra::Model::SalesforceConfiguration::GetSecretArn ( ) const
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 101 of file SalesforceConfiguration.h.

◆ GetServerUrl()

const Aws::String& Aws::kendra::Model::SalesforceConfiguration::GetServerUrl ( ) const
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 49 of file SalesforceConfiguration.h.

◆ GetStandardObjectAttachmentConfiguration()

const SalesforceStandardObjectAttachmentConfiguration& Aws::kendra::Model::SalesforceConfiguration::GetStandardObjectAttachmentConfiguration ( ) const
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 366 of file SalesforceConfiguration.h.

◆ GetStandardObjectConfigurations()

const Aws::Vector<SalesforceStandardObjectConfiguration>& Aws::kendra::Model::SalesforceConfiguration::GetStandardObjectConfigurations ( ) const
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 219 of file SalesforceConfiguration.h.

◆ IncludeAttachmentFilePatternsHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::IncludeAttachmentFilePatternsHasBeenSet ( ) const
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 415 of file SalesforceConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::kendra::Model::SalesforceConfiguration::Jsonize ( ) const

◆ KnowledgeArticleConfigurationHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::KnowledgeArticleConfigurationHasBeenSet ( ) const
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 271 of file SalesforceConfiguration.h.

◆ operator=()

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SecretArnHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::SecretArnHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 117 of file SalesforceConfiguration.h.

◆ ServerUrlHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::ServerUrlHasBeenSet ( ) const
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 54 of file SalesforceConfiguration.h.

◆ SetChatterFeedConfiguration() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetChatterFeedConfiguration ( const SalesforceChatterFeedConfiguration value)
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 319 of file SalesforceConfiguration.h.

◆ SetChatterFeedConfiguration() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetChatterFeedConfiguration ( SalesforceChatterFeedConfiguration &&  value)
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 324 of file SalesforceConfiguration.h.

◆ SetCrawlAttachments()

void Aws::kendra::Model::SalesforceConfiguration::SetCrawlAttachments ( bool  value)
inline

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Definition at line 353 of file SalesforceConfiguration.h.

◆ SetExcludeAttachmentFilePatterns() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetExcludeAttachmentFilePatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 515 of file SalesforceConfiguration.h.

◆ SetExcludeAttachmentFilePatterns() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetExcludeAttachmentFilePatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 506 of file SalesforceConfiguration.h.

◆ SetIncludeAttachmentFilePatterns() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetIncludeAttachmentFilePatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 433 of file SalesforceConfiguration.h.

◆ SetIncludeAttachmentFilePatterns() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetIncludeAttachmentFilePatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 424 of file SalesforceConfiguration.h.

◆ SetKnowledgeArticleConfiguration() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetKnowledgeArticleConfiguration ( const SalesforceKnowledgeArticleConfiguration value)
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 279 of file SalesforceConfiguration.h.

◆ SetKnowledgeArticleConfiguration() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetKnowledgeArticleConfiguration ( SalesforceKnowledgeArticleConfiguration &&  value)
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 287 of file SalesforceConfiguration.h.

◆ SetSecretArn() [1/3]

void Aws::kendra::Model::SalesforceConfiguration::SetSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 149 of file SalesforceConfiguration.h.

◆ SetSecretArn() [2/3]

void Aws::kendra::Model::SalesforceConfiguration::SetSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 133 of file SalesforceConfiguration.h.

◆ SetSecretArn() [3/3]

void Aws::kendra::Model::SalesforceConfiguration::SetSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 165 of file SalesforceConfiguration.h.

◆ SetServerUrl() [1/3]

void Aws::kendra::Model::SalesforceConfiguration::SetServerUrl ( Aws::String &&  value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 64 of file SalesforceConfiguration.h.

◆ SetServerUrl() [2/3]

void Aws::kendra::Model::SalesforceConfiguration::SetServerUrl ( const Aws::String value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 59 of file SalesforceConfiguration.h.

◆ SetServerUrl() [3/3]

void Aws::kendra::Model::SalesforceConfiguration::SetServerUrl ( const char *  value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 69 of file SalesforceConfiguration.h.

◆ SetStandardObjectAttachmentConfiguration() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetStandardObjectAttachmentConfiguration ( const SalesforceStandardObjectAttachmentConfiguration value)
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 378 of file SalesforceConfiguration.h.

◆ SetStandardObjectAttachmentConfiguration() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetStandardObjectAttachmentConfiguration ( SalesforceStandardObjectAttachmentConfiguration &&  value)
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 384 of file SalesforceConfiguration.h.

◆ SetStandardObjectConfigurations() [1/2]

void Aws::kendra::Model::SalesforceConfiguration::SetStandardObjectConfigurations ( Aws::Vector< SalesforceStandardObjectConfiguration > &&  value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 234 of file SalesforceConfiguration.h.

◆ SetStandardObjectConfigurations() [2/2]

void Aws::kendra::Model::SalesforceConfiguration::SetStandardObjectConfigurations ( const Aws::Vector< SalesforceStandardObjectConfiguration > &  value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 229 of file SalesforceConfiguration.h.

◆ StandardObjectAttachmentConfigurationHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::StandardObjectAttachmentConfigurationHasBeenSet ( ) const
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 372 of file SalesforceConfiguration.h.

◆ StandardObjectConfigurationsHasBeenSet()

bool Aws::kendra::Model::SalesforceConfiguration::StandardObjectConfigurationsHasBeenSet ( ) const
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 224 of file SalesforceConfiguration.h.

◆ WithChatterFeedConfiguration() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithChatterFeedConfiguration ( const SalesforceChatterFeedConfiguration value)
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 329 of file SalesforceConfiguration.h.

◆ WithChatterFeedConfiguration() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithChatterFeedConfiguration ( SalesforceChatterFeedConfiguration &&  value)
inline

Specifies configuration information for Salesforce chatter feeds.

Definition at line 334 of file SalesforceConfiguration.h.

◆ WithCrawlAttachments()

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithCrawlAttachments ( bool  value)
inline

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

Definition at line 359 of file SalesforceConfiguration.h.

◆ WithExcludeAttachmentFilePatterns() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithExcludeAttachmentFilePatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 533 of file SalesforceConfiguration.h.

◆ WithExcludeAttachmentFilePatterns() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithExcludeAttachmentFilePatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are excluded from the index. Documents that don't match the patterns are included in the index. If a document matches both an exclusion pattern and an inclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 524 of file SalesforceConfiguration.h.

◆ WithIncludeAttachmentFilePatterns() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithIncludeAttachmentFilePatterns ( Aws::Vector< Aws::String > &&  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 451 of file SalesforceConfiguration.h.

◆ WithIncludeAttachmentFilePatterns() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithIncludeAttachmentFilePatterns ( const Aws::Vector< Aws::String > &  value)
inline

A list of regular expression patterns. Documents that match the patterns are included in the index. Documents that don't match the patterns are excluded from the index. If a document matches both an inclusion pattern and an exclusion pattern, the document is not included in the index.

The regex is applied to the name of the attached file.

Definition at line 442 of file SalesforceConfiguration.h.

◆ WithKnowledgeArticleConfiguration() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithKnowledgeArticleConfiguration ( const SalesforceKnowledgeArticleConfiguration value)
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 295 of file SalesforceConfiguration.h.

◆ WithKnowledgeArticleConfiguration() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithKnowledgeArticleConfiguration ( SalesforceKnowledgeArticleConfiguration &&  value)
inline

Specifies configuration information for the knowledge article types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge articles and the standard fields of knowledge articles, or the custom fields of custom knowledge articles, but not both.

Definition at line 303 of file SalesforceConfiguration.h.

◆ WithSecretArn() [1/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithSecretArn ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 197 of file SalesforceConfiguration.h.

◆ WithSecretArn() [2/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithSecretArn ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 181 of file SalesforceConfiguration.h.

◆ WithSecretArn() [3/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithSecretArn ( const char *  value)
inline

The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance. The secret must contain a JSON structure with the following keys:

  • authenticationUrl - The OAUTH endpoint that Amazon Kendra connects to get an OAUTH token.

  • consumerKey - The application public key generated when you created your Salesforce application.

  • consumerSecret - The application private key generated when you created your Salesforce application.

  • password - The password associated with the user logging in to the Salesforce instance.

  • securityToken - The token associated with the user account logging in to the Salesforce instance.

  • username - The user name of the user logging in to the Salesforce instance.

Definition at line 213 of file SalesforceConfiguration.h.

◆ WithServerUrl() [1/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithServerUrl ( Aws::String &&  value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 79 of file SalesforceConfiguration.h.

◆ WithServerUrl() [2/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithServerUrl ( const Aws::String value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 74 of file SalesforceConfiguration.h.

◆ WithServerUrl() [3/3]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithServerUrl ( const char *  value)
inline

The instance URL for the Salesforce site that you want to index.

Definition at line 84 of file SalesforceConfiguration.h.

◆ WithStandardObjectAttachmentConfiguration() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithStandardObjectAttachmentConfiguration ( const SalesforceStandardObjectAttachmentConfiguration value)
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 390 of file SalesforceConfiguration.h.

◆ WithStandardObjectAttachmentConfiguration() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithStandardObjectAttachmentConfiguration ( SalesforceStandardObjectAttachmentConfiguration &&  value)
inline

Provides configuration information for processing attachments to Salesforce standard objects.

Definition at line 396 of file SalesforceConfiguration.h.

◆ WithStandardObjectConfigurations() [1/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithStandardObjectConfigurations ( Aws::Vector< SalesforceStandardObjectConfiguration > &&  value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 244 of file SalesforceConfiguration.h.

◆ WithStandardObjectConfigurations() [2/2]

SalesforceConfiguration& Aws::kendra::Model::SalesforceConfiguration::WithStandardObjectConfigurations ( const Aws::Vector< SalesforceStandardObjectConfiguration > &  value)
inline

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Definition at line 239 of file SalesforceConfiguration.h.


The documentation for this class was generated from the following file: