software.amazon.awscdk.services.kendra

Interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

All Known Implementing Classes:

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

public static interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kendra.*;
 ServiceNowKnowledgeArticleConfigurationProperty serviceNowKnowledgeArticleConfigurationProperty = ServiceNowKnowledgeArticleConfigurationProperty.builder()
         .documentDataFieldName("documentDataFieldName")
         // the properties below are optional
         .crawlAttachments(false)
         .documentTitleFieldName("documentTitleFieldName")
         .excludeAttachmentFilePatterns(List.of("excludeAttachmentFilePatterns"))
         .fieldMappings(List.of(DataSourceToIndexFieldMappingProperty.builder()
                 .dataSourceFieldName("dataSourceFieldName")
                 .indexFieldName("indexFieldName")
                 // the properties below are optional
                 .dateFieldFormat("dateFieldFormat")
                 .build()))
         .filterQuery("filterQuery")
         .includeAttachmentFilePatterns(List.of("includeAttachmentFilePatterns"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder A builder for CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty
static class	CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy An implementation for CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder	builder()
default java.lang.Object	getCrawlAttachments() Indicates whether Amazon Kendra should index attachments to knowledge articles.
java.lang.String	getDocumentDataFieldName() The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
default java.lang.String	getDocumentTitleFieldName() The name of the ServiceNow field that is mapped to the index document title field.
default java.util.List<java.lang.String>	getExcludeAttachmentFilePatterns() A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.
default java.lang.Object	getFieldMappings() Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
default java.lang.String	getFilterQuery() A query that selects the knowledge articles to index.
default java.util.List<java.lang.String>	getIncludeAttachmentFilePatterns() A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.

Method Detail

getDocumentDataFieldName

java.lang.String getDocumentDataFieldName()

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

getCrawlAttachments

default java.lang.Object getCrawlAttachments()

Indicates whether Amazon Kendra should index attachments to knowledge articles.

getDocumentTitleFieldName

default java.lang.String getDocumentTitleFieldName()

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

getExcludeAttachmentFilePatterns

default java.util.List<java.lang.String> getExcludeAttachmentFilePatterns()

A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.

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

The regex is applied to the field specified in the PatternTargetField .

getFieldMappings

default java.lang.Object getFieldMappings()

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.

getFilterQuery

default java.lang.String getFilterQuery()

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 .

getIncludeAttachmentFilePatterns

default java.util.List<java.lang.String> getIncludeAttachmentFilePatterns()

A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.

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

The regex is applied to the field specified in the PatternTargetField .

builder

static CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder of CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty