Struct SalesforceConfiguration 

#[non_exhaustive]
pub struct SalesforceConfiguration {
    pub server_url: String,
    pub secret_arn: String,
    pub standard_object_configurations: Option<Vec<SalesforceStandardObjectConfiguration>>,
    pub knowledge_article_configuration: Option<SalesforceKnowledgeArticleConfiguration>,
    pub chatter_feed_configuration: Option<SalesforceChatterFeedConfiguration>,
    pub crawl_attachments: bool,
    pub standard_object_attachment_configuration: Option<SalesforceStandardObjectAttachmentConfiguration>,
    pub include_attachment_file_patterns: Option<Vec<String>>,
    pub exclude_attachment_file_patterns: Option<Vec<String>>,
}

Provides the configuration information to connect to Salesforce as your data source.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

server_url: String

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

secret_arn: String

The Amazon Resource Name (ARN) of an Secrets Managersecret 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 logging in to the Salesforce instance.

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

standard_object_configurations: Option<Vec<SalesforceStandardObjectConfiguration>>

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

knowledge_article_configuration: Option<SalesforceKnowledgeArticleConfiguration>

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.

chatter_feed_configuration: Option<SalesforceChatterFeedConfiguration>

Configuration information for Salesforce chatter feeds.

crawl_attachments: bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

standard_object_attachment_configuration: Option<SalesforceStandardObjectAttachmentConfiguration>

Configuration information for processing attachments to Salesforce standard objects.

include_attachment_file_patterns: Option<Vec<String>>

A list of regular expression patterns to include certain documents in your Salesforce. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

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

exclude_attachment_file_patterns: Option<Vec<String>>

A list of regular expression patterns to exclude certain documents in your Salesforce. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

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

Implementations

impl SalesforceConfiguration

pub fn server_url(&self) -> &str

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

pub fn secret_arn(&self) -> &str

The Amazon Resource Name (ARN) of an Secrets Managersecret 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 logging in to the Salesforce instance.

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

pub fn standard_object_configurations( &self, ) -> &[SalesforceStandardObjectConfiguration]

Configuration of the Salesforce standard objects that Amazon Kendra indexes.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .standard_object_configurations.is_none().

pub fn knowledge_article_configuration( &self, ) -> Option<&SalesforceKnowledgeArticleConfiguration>

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.

pub fn chatter_feed_configuration( &self, ) -> Option<&SalesforceChatterFeedConfiguration>

Configuration information for Salesforce chatter feeds.

pub fn crawl_attachments(&self) -> bool

Indicates whether Amazon Kendra should index attachments to Salesforce objects.

pub fn standard_object_attachment_configuration( &self, ) -> Option<&SalesforceStandardObjectAttachmentConfiguration>

Configuration information for processing attachments to Salesforce standard objects.

pub fn include_attachment_file_patterns(&self) -> &[String]

A list of regular expression patterns to include certain documents in your Salesforce. 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 and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .include_attachment_file_patterns.is_none().

pub fn exclude_attachment_file_patterns(&self) -> &[String]

A list of regular expression patterns to exclude certain documents in your Salesforce. 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 inclusion and exclusion pattern, the exclusion pattern takes precedence and the document isn't included in the index.

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclude_attachment_file_patterns.is_none().

impl SalesforceConfiguration

pub fn builder() -> SalesforceConfigurationBuilder

Creates a new builder-style object to manufacture SalesforceConfiguration.

Trait Implementations

impl Clone for SalesforceConfiguration

fn clone(&self) -> SalesforceConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SalesforceConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for SalesforceConfiguration

fn eq(&self, other: &SalesforceConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SalesforceConfiguration