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 Summary

Modifier and Type	Method and Description
default SalesforceConfiguration.Builder	chatterFeedConfiguration(Consumer<SalesforceChatterFeedConfiguration.Builder> chatterFeedConfiguration) Specifies configuration information for Salesforce chatter feeds.
SalesforceConfiguration.Builder	chatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration) Specifies configuration information for Salesforce chatter feeds.
SalesforceConfiguration.Builder	crawlAttachments(Boolean crawlAttachments) Indicates whether Amazon Kendra should index attachments to Salesforce objects.
SalesforceConfiguration.Builder	excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns) A list of regular expression patterns.
SalesforceConfiguration.Builder	excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns) A list of regular expression patterns.
SalesforceConfiguration.Builder	includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns) A list of regular expression patterns.
SalesforceConfiguration.Builder	includeAttachmentFilePatterns(String... includeAttachmentFilePatterns) A list of regular expression patterns.
default SalesforceConfiguration.Builder	knowledgeArticleConfiguration(Consumer<SalesforceKnowledgeArticleConfiguration.Builder> knowledgeArticleConfiguration) Specifies configuration information for the knowledge article types that Amazon Kendra indexes.
SalesforceConfiguration.Builder	knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration) Specifies configuration information for the knowledge article types that Amazon Kendra indexes.
SalesforceConfiguration.Builder	secretArn(String secretArn) The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that contains the key/value pairs required to connect to your Salesforce instance.
SalesforceConfiguration.Builder	serverUrl(String serverUrl) The instance URL for the Salesforce site that you want to index.
default SalesforceConfiguration.Builder	standardObjectAttachmentConfiguration(Consumer<SalesforceStandardObjectAttachmentConfiguration.Builder> standardObjectAttachmentConfiguration) Provides configuration information for processing attachments to Salesforce standard objects.
SalesforceConfiguration.Builder	standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration standardObjectAttachmentConfiguration) Provides configuration information for processing attachments to Salesforce standard objects.
SalesforceConfiguration.Builder	standardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations) Specifies the Salesforce standard objects that Amazon Kendra indexes.
SalesforceConfiguration.Builder	standardObjectConfigurations(Consumer<SalesforceStandardObjectConfiguration.Builder>... standardObjectConfigurations) Specifies the Salesforce standard objects that Amazon Kendra indexes.
SalesforceConfiguration.Builder	standardObjectConfigurations(SalesforceStandardObjectConfiguration... standardObjectConfigurations) Specifies the Salesforce standard objects that Amazon Kendra indexes.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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 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.

Parameters:

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

Returns:

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

standardObjectConfigurations

SalesforceConfiguration.Builder standardObjectConfigurations(Collection<SalesforceStandardObjectConfiguration> standardObjectConfigurations)

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Parameters:

standardObjectConfigurations - Specifies 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)

Specifies the Salesforce standard objects that Amazon Kendra indexes.

Parameters:

standardObjectConfigurations - Specifies 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)

Specifies the Salesforce standard objects that Amazon Kendra indexes.

This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #standardObjectConfigurations(List).

Parameters:

standardObjectConfigurations - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#standardObjectConfigurations(List)

knowledgeArticleConfiguration

SalesforceConfiguration.Builder knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration knowledgeArticleConfiguration)

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.

Parameters:

knowledgeArticleConfiguration - 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.

Returns:

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

knowledgeArticleConfiguration

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

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.

This is a convenience 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:

knowledgeArticleConfiguration(SalesforceKnowledgeArticleConfiguration)

chatterFeedConfiguration

SalesforceConfiguration.Builder chatterFeedConfiguration(SalesforceChatterFeedConfiguration chatterFeedConfiguration)

Specifies configuration information for Salesforce chatter feeds.

Parameters:

chatterFeedConfiguration - Specifies 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)

Specifies configuration information for Salesforce chatter feeds.

This is a convenience 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:

chatterFeedConfiguration(SalesforceChatterFeedConfiguration)

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)

Provides configuration information for processing attachments to Salesforce standard objects.

Parameters:

standardObjectAttachmentConfiguration - Provides 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)

Provides configuration information for processing attachments to Salesforce standard objects.

This is a convenience 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:

standardObjectAttachmentConfiguration(SalesforceStandardObjectAttachmentConfiguration)

includeAttachmentFilePatterns

SalesforceConfiguration.Builder includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)

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.

Parameters:

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

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. 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.

Parameters:

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

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. 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.

Parameters:

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

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. 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.

Parameters:

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

Returns:

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