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) TRUE to 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) A list of regular expression patterns applied to exclude certain knowledge article attachments.
ServiceNowKnowledgeArticleConfiguration.Builder	excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns) A list of regular expression patterns applied to exclude certain knowledge article attachments.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings) Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(Consumer<DataSourceToIndexFieldMapping.Builder>... fieldMappings) Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
ServiceNowKnowledgeArticleConfiguration.Builder	fieldMappings(DataSourceToIndexFieldMapping... fieldMappings) Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
ServiceNowKnowledgeArticleConfiguration.Builder	filterQuery(String filterQuery) A query that selects the knowledge articles to index.
ServiceNowKnowledgeArticleConfiguration.Builder	includeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns) A list of regular expression patterns applied to include knowledge article attachments.
ServiceNowKnowledgeArticleConfiguration.Builder	includeAttachmentFilePatterns(String... includeAttachmentFilePatterns) A list of regular expression patterns applied to include knowledge article attachments.

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)

TRUE to index attachments to knowledge articles.

Parameters:

crawlAttachments - TRUE to 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)

A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Parameters:

includeAttachmentFilePatterns - A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Returns:

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

includeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder includeAttachmentFilePatterns(String... includeAttachmentFilePatterns)

A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Parameters:

includeAttachmentFilePatterns - A list of regular expression patterns applied to include knowledge article attachments. Attachments that match the patterns are included in the index. Items that don't match the patterns are excluded from the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Returns:

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

excludeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder excludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)

A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Parameters:

excludeAttachmentFilePatterns - A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Returns:

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

excludeAttachmentFilePatterns

ServiceNowKnowledgeArticleConfiguration.Builder excludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)

A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

Parameters:

excludeAttachmentFilePatterns - A list of regular expression patterns applied to exclude certain knowledge article attachments. Attachments that match the patterns are excluded from the index. Items that don't match the patterns are included in the index. If an item matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the item isn't included in the index.

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)

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

Parameters:

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

Returns:

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

fieldMappings

ServiceNowKnowledgeArticleConfiguration.Builder fieldMappings(DataSourceToIndexFieldMapping... fieldMappings)

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

Parameters:

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

Returns:

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

fieldMappings

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

Maps attributes or field names of knoweldge articles to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to ServiceNow fields. For more information, see Mapping data source fields. The ServiceNow data source field names must exist in your ServiceNow 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)

filterQuery

ServiceNowKnowledgeArticleConfiguration.Builder filterQuery(String filterQuery)

A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

Parameters:

filterQuery - A query that selects the knowledge articles to index. The query can return articles from multiple knowledge bases, and the knowledge bases can be public or private.

The query string must be one generated by the ServiceNow console. For more information, see Specifying documents to index with a query.

Returns:

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