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

Interface SalesforceCustomKnowledgeArticleTypeConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SalesforceCustomKnowledgeArticleTypeConfiguration.Builder,SalesforceCustomKnowledgeArticleTypeConfiguration>, SdkBuilder<SalesforceCustomKnowledgeArticleTypeConfiguration.Builder,SalesforceCustomKnowledgeArticleTypeConfiguration>, SdkPojo

Enclosing class:

SalesforceCustomKnowledgeArticleTypeConfiguration

public static interface SalesforceCustomKnowledgeArticleTypeConfiguration.Builder
extends SdkPojo, CopyableBuilder<SalesforceCustomKnowledgeArticleTypeConfiguration.Builder,SalesforceCustomKnowledgeArticleTypeConfiguration>

Method Summary

Modifier and Type	Method	Description
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	documentDataFieldName(String documentDataFieldName)	The name of the field in the custom knowledge article that contains the document data to index.
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	documentTitleFieldName(String documentTitleFieldName)	The name of the field in the custom knowledge article that contains the document title.
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)	Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)	Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)	Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names.
SalesforceCustomKnowledgeArticleTypeConfiguration.Builder	name(String name)	The name of the configuration.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Detail

name

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder name(String name)

The name of the configuration.

Parameters:

name - The name of the configuration.

Returns:

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

documentDataFieldName

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder documentDataFieldName(String documentDataFieldName)

The name of the field in the custom knowledge article that contains the document data to index.

Parameters:

documentDataFieldName - The name of the field in the custom knowledge article that contains the document data to index.

Returns:

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

documentTitleFieldName

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder documentTitleFieldName(String documentTitleFieldName)

The name of the field in the custom knowledge article that contains the document title.

Parameters:

documentTitleFieldName - The name of the field in the custom knowledge article that contains the document title.

Returns:

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

fieldMappings

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Parameters:

fieldMappings - Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:

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

fieldMappings

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Parameters:

fieldMappings - Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

Returns:

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

fieldMappings

SalesforceCustomKnowledgeArticleTypeConfiguration.Builder fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings)

Maps attributes or field names of the custom knowledge article to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Salesforce fields. For more information, see Mapping data source fields. The Salesforce data source field names must exist in your Salesforce custom metadata.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #fieldMappings(List).

Parameters:

fieldMappings - a consumer that will call methods on DataSourceToIndexFieldMapping.Builder

Returns:

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

See Also:

#fieldMappings(java.util.Collection)