Package software.amazon.awscdk.cfnpropertymixins.services.kendra

Class CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.kendra.CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty>

Enclosing interface:

CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty

@Stability(Stable)
public static final class CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty>

A builder for CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty	build()	Builds the configured instance.
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	crawlAttachments(Boolean crawlAttachments)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getCrawlAttachments()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	crawlAttachments(IResolvable crawlAttachments)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getCrawlAttachments()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	documentDataFieldName(String documentDataFieldName)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getDocumentDataFieldName()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	documentTitleFieldName(String documentTitleFieldName)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getDocumentTitleFieldName()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	excludeAttachmentFilePatterns(List<String> excludeAttachmentFilePatterns)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getExcludeAttachmentFilePatterns()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	fieldMappings(List<? extends Object> fieldMappings)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFieldMappings()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	fieldMappings(IResolvable fieldMappings)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFieldMappings()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	filterQuery(String filterQuery)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFilterQuery()
CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder	includeAttachmentFilePatterns(List<String> includeAttachmentFilePatterns)	Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getIncludeAttachmentFilePatterns()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

crawlAttachments

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder crawlAttachments(Boolean crawlAttachments)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index attachments to knowledge articles.

Returns:

this

crawlAttachments

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder crawlAttachments(IResolvable crawlAttachments)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getCrawlAttachments()

Parameters:

crawlAttachments - TRUE to index attachments to knowledge articles.

Returns:

this

documentDataFieldName

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder documentDataFieldName(String documentDataFieldName)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getDocumentDataFieldName()

Parameters:

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

Returns:

this

documentTitleFieldName

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder documentTitleFieldName(String documentTitleFieldName)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getDocumentTitleFieldName()

Parameters:

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

Returns:

this

excludeAttachmentFilePatterns

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder excludeAttachmentFilePatterns(List<String> excludeAttachmentFilePatterns)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getExcludeAttachmentFilePatterns()

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:

this

fieldMappings

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder fieldMappings(IResolvable fieldMappings)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFieldMappings()

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:

this

fieldMappings

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder fieldMappings(List<? extends Object> fieldMappings)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFieldMappings()

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:

this

filterQuery

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder filterQuery(String filterQuery)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getFilterQuery()

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:

this

includeAttachmentFilePatterns

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.Builder includeAttachmentFilePatterns(List<String> includeAttachmentFilePatterns)

Sets the value of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty.getIncludeAttachmentFilePatterns()

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:

this

build

@Stability(Stable)
public CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty>

Returns:

a new instance of CfnDataSourcePropsMixin.ServiceNowKnowledgeArticleConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided