software.amazon.awssdk.services.kendra.model

Interface ServiceNowKnowledgeArticleConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

ServiceNowKnowledgeArticleConfiguration

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

Method Summary

Modifier and Type	Method and Description
ServiceNowKnowledgeArticleConfiguration.Builder	crawlAttachments(Boolean crawlAttachments) Indicates whether Amazon Kendra should index attachments to knowledge articles.
ServiceNowKnowledgeArticleConfiguration.Builder	documentDataFieldName(String documentDataFieldName) The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
ServiceNowKnowledgeArticleConfiguration.Builder	documentTitleFieldName(String documentTitleFieldName) The name of the ServiceNow field that is mapped to the index document title field.
ServiceNowKnowledgeArticleConfiguration.Builder	excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns) List of regular expressions applied to knowledge articles.
ServiceNowKnowledgeArticleConfiguration.Builder	excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns) List of regular expressions applied to knowledge articles.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) Mapping between ServiceNow fields and Amazon Kendra index fields.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings) Mapping between ServiceNow fields and Amazon Kendra index fields.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(DataSourceToIndexFieldMapping... fieldMappings) Mapping between ServiceNow fields and Amazon Kendra index fields.
ServiceNowKnowledgeArticleConfiguration.Builder	includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns) List of regular expressions applied to knowledge articles.
ServiceNowKnowledgeArticleConfiguration.Builder	includeAttachmentFilePatterns(String... includeAttachmentFilePatterns) List of regular expressions applied to knowledge articles.

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

crawlAttachments

ServiceNowKnowledgeArticleConfiguration.Builder crawlAttachments(Boolean crawlAttachments)

Indicates whether Amazon Kendra should index attachments to knowledge articles.

Parameters:

crawlAttachments - Indicates whether Amazon Kendra should index attachments to knowledge articles.

Returns:

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

includeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

Parameters:

includeAttachmentFilePatterns - List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

Returns:

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

includeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder includeAttachmentFilePatterns(String... includeAttachmentFilePatterns)

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

Parameters:

includeAttachmentFilePatterns - List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField.

Returns:

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

excludeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

Parameters:

excludeAttachmentFilePatterns - List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

Returns:

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

excludeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)

List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

Parameters:

excludeAttachmentFilePatterns - List of regular expressions applied to knowledge articles. Items that don't match the inclusion pattern are not indexed. The regex is applied to the field specified in the PatternTargetField

Returns:

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

documentDataFieldName

ServiceNowKnowledgeArticleConfiguration.Builder documentDataFieldName(String documentDataFieldName)

The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Parameters:

documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.

Returns:

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

documentTitleFieldName

ServiceNowKnowledgeArticleConfiguration.Builder documentTitleFieldName(String documentTitleFieldName)

The name of the ServiceNow field that is mapped to the index document title field.

Parameters:

documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.

Returns:

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

fieldMappings

ServiceNowKnowledgeArticleConfiguration.Builder fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

Parameters:

fieldMappings - Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

Returns:

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

fieldMappings

ServiceNowKnowledgeArticleConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

Parameters:

fieldMappings - Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

Returns:

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

fieldMappings

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

Mapping between ServiceNow fields and Amazon Kendra index fields. You must create the index field before you map the field.

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

Parameters:

fieldMappings - 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:

#fieldMappings(List)