Class CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSource.ServiceNowServiceCatalogConfigurationProperty>
- Enclosing interface:
CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
@Stability(Stable)
public static final class CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSource.ServiceNowServiceCatalogConfigurationProperty>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.crawlAttachments
(Boolean crawlAttachments) crawlAttachments
(IResolvable crawlAttachments) documentDataFieldName
(String documentDataFieldName) documentTitleFieldName
(String documentTitleFieldName) excludeAttachmentFilePatterns
(List<String> excludeAttachmentFilePatterns) fieldMappings
(List<? extends Object> fieldMappings) fieldMappings
(IResolvable fieldMappings) includeAttachmentFilePatterns
(List<String> includeAttachmentFilePatterns)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
documentDataFieldName
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder documentDataFieldName(String documentDataFieldName) Sets the value ofCfnDataSource.ServiceNowServiceCatalogConfigurationProperty.getDocumentDataFieldName()
- Parameters:
documentDataFieldName
- The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index. This parameter is required.- Returns:
this
-
crawlAttachments
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder crawlAttachments(Boolean crawlAttachments) - Parameters:
crawlAttachments
-TRUE
to index attachments to service catalog items.- Returns:
this
-
crawlAttachments
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder crawlAttachments(IResolvable crawlAttachments) - Parameters:
crawlAttachments
-TRUE
to index attachments to service catalog items.- Returns:
this
-
documentTitleFieldName
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder documentTitleFieldName(String documentTitleFieldName) Sets the value ofCfnDataSource.ServiceNowServiceCatalogConfigurationProperty.getDocumentTitleFieldName()
- Parameters:
documentTitleFieldName
- The name of the ServiceNow field that is mapped to the index document title field.- Returns:
this
-
excludeAttachmentFilePatterns
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder excludeAttachmentFilePatterns(List<String> excludeAttachmentFilePatterns) Sets the value ofCfnDataSource.ServiceNowServiceCatalogConfigurationProperty.getExcludeAttachmentFilePatterns()
- Parameters:
excludeAttachmentFilePatterns
- A list of regular expression patterns to exclude certain attachments of catalogs 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 file name of the attachment.
- Returns:
this
-
fieldMappings
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder fieldMappings(IResolvable fieldMappings) - Parameters:
fieldMappings
- Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
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 CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder fieldMappings(List<? extends Object> fieldMappings) - Parameters:
fieldMappings
- Maps attributes or field names of catalogs to Amazon Kendra index field names. To create custom fields, use theUpdateIndex
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
-
includeAttachmentFilePatterns
@Stability(Stable) public CfnDataSource.ServiceNowServiceCatalogConfigurationProperty.Builder includeAttachmentFilePatterns(List<String> includeAttachmentFilePatterns) Sets the value ofCfnDataSource.ServiceNowServiceCatalogConfigurationProperty.getIncludeAttachmentFilePatterns()
- Parameters:
includeAttachmentFilePatterns
- A list of regular expression patterns to include certain attachments of catalogs 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 file name of the attachment.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDataSource.ServiceNowServiceCatalogConfigurationProperty>
- Returns:
- a new instance of
CfnDataSource.ServiceNowServiceCatalogConfigurationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-