Package software.amazon.awssdk.services.kendra.model

Interface SalesforceConfiguration.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>, SdkBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>, SdkPojo
Enclosing class:
SalesforceConfiguration
public static interface SalesforceConfiguration.Builder extends SdkPojo, CopyableBuilder<SalesforceConfiguration.Builder,SalesforceConfiguration>

  • Method Details

    • serverUrl

      SalesforceConfiguration.Builder serverUrl(String serverUrl)

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

      Parameters:
      serverUrl - The instance URL for the Salesforce site that you want to index.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretArn

      SalesforceConfiguration.Builder secretArn(String secretArn)

      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.

      Parameters:
      secretArn - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardObjectConfigurations

      SalesforceConfiguration.Builder standardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)

      Configuration of the Salesforce standard objects that Amazon Kendra indexes.

      Parameters:
      standardObjectConfigurations - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardObjectConfigurations

      SalesforceConfiguration.Builder standardObjectConfigurations(SalesforceStandardObjectConfiguration... standardObjectConfigurations)

      Configuration of the Salesforce standard objects that Amazon Kendra indexes.

      Parameters:
      standardObjectConfigurations - Configuration of the Salesforce standard objects that Amazon Kendra indexes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardObjectConfigurations

      SalesforceConfiguration.Builder standardObjectConfigurations(Consumer<SalesforceStandardObjectConfiguration.Builder>... standardObjectConfigurations)

      Configuration of the Salesforce standard objects that Amazon Kendra indexes.

      This is a convenience method that creates an instance of the SalesforceStandardObjectConfiguration.Builder avoiding the need to create one manually via SalesforceStandardObjectConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to standardObjectConfigurations(List<SalesforceStandardObjectConfiguration>).

      Parameters:
      standardObjectConfigurations - a consumer that will call methods on SalesforceStandardObjectConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • knowledgeArticleConfiguration

      SalesforceConfiguration.Builder knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)

      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.

      Parameters:
      knowledgeArticleConfiguration - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • knowledgeArticleConfiguration

      default SalesforceConfiguration.Builder knowledgeArticleConfiguration(Consumer<SalesforceKnowledgeArticleConfiguration.Builder> knowledgeArticleConfiguration)

      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.

      This is a convenience method that creates an instance of the SalesforceKnowledgeArticleConfiguration.Builder avoiding the need to create one manually via SalesforceKnowledgeArticleConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration).

      Parameters:
      knowledgeArticleConfiguration - a consumer that will call methods on SalesforceKnowledgeArticleConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • chatterFeedConfiguration

      SalesforceConfiguration.Builder chatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)

      Configuration information for Salesforce chatter feeds.

      Parameters:
      chatterFeedConfiguration - Configuration information for Salesforce chatter feeds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • chatterFeedConfiguration

      default SalesforceConfiguration.Builder chatterFeedConfiguration(Consumer<SalesforceChatterFeedConfiguration.Builder> chatterFeedConfiguration)

      Configuration information for Salesforce chatter feeds.

      This is a convenience method that creates an instance of the SalesforceChatterFeedConfiguration.Builder avoiding the need to create one manually via SalesforceChatterFeedConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to chatterFeedConfiguration(SalesforceChatterFeedConfiguration).

      Parameters:
      chatterFeedConfiguration - a consumer that will call methods on SalesforceChatterFeedConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • crawlAttachments

      SalesforceConfiguration.Builder crawlAttachments(Boolean crawlAttachments)

      Indicates whether Amazon Kendra should index attachments to Salesforce objects.

      Parameters:
      crawlAttachments - Indicates whether Amazon Kendra should index attachments to Salesforce objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardObjectAttachmentConfiguration

      SalesforceConfiguration.Builder standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration)

      Configuration information for processing attachments to Salesforce standard objects.

      Parameters:
      standardObjectAttachmentConfiguration - Configuration information for processing attachments to Salesforce standard objects.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • standardObjectAttachmentConfiguration

      default SalesforceConfiguration.Builder standardObjectAttachmentConfiguration(Consumer<SalesforceStandardObjectAttachmentConfiguration.Builder> standardObjectAttachmentConfiguration)

      Configuration information for processing attachments to Salesforce standard objects.

      This is a convenience method that creates an instance of the SalesforceStandardObjectAttachmentConfiguration.Builder avoiding the need to create one manually via SalesforceStandardObjectAttachmentConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration).

      Parameters:
      standardObjectAttachmentConfiguration - a consumer that will call methods on SalesforceStandardObjectAttachmentConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • includeAttachmentFilePatterns

      SalesforceConfiguration.Builder includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)

      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.

      Parameters:
      includeAttachmentFilePatterns - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeAttachmentFilePatterns

      SalesforceConfiguration.Builder includeAttachmentFilePatterns(String... includeAttachmentFilePatterns)

      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.

      Parameters:
      includeAttachmentFilePatterns - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeAttachmentFilePatterns

      SalesforceConfiguration.Builder excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)

      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.

      Parameters:
      excludeAttachmentFilePatterns - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • excludeAttachmentFilePatterns

      SalesforceConfiguration.Builder excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)

      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.

      Parameters:
      excludeAttachmentFilePatterns - 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.