software.amazon.awscdk.services.kendra

Interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSource

@Stability(value=Stable)
public static interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 Object	getCrawlAttachments() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.CrawlAttachments`.
String	getDocumentDataFieldName() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentDataFieldName`.
default String	getDocumentTitleFieldName() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentTitleFieldName`.
default List<String>	getExcludeAttachmentFilePatterns() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns`.
default Object	getFieldMappings() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings`.
default String	getFilterQuery() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FilterQuery`.
default List<String>	getIncludeAttachmentFilePatterns() `CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCrawlAttachments

@Stability(value=Stable)
 @Nullable
default Object getCrawlAttachments()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.CrawlAttachments`.

getDocumentDataFieldName

@Stability(value=Stable)
 @NotNull
String getDocumentDataFieldName()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentDataFieldName`.

getDocumentTitleFieldName

@Stability(value=Stable)
 @Nullable
default String getDocumentTitleFieldName()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.DocumentTitleFieldName`.

getExcludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getExcludeAttachmentFilePatterns()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.ExcludeAttachmentFilePatterns`.

getFieldMappings

@Stability(value=Stable)
 @Nullable
default Object getFieldMappings()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FieldMappings`.

getFilterQuery

@Stability(value=Stable)
 @Nullable
default String getFilterQuery()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.FilterQuery`.

getIncludeAttachmentFilePatterns

@Stability(value=Stable)
 @Nullable
default List<String> getIncludeAttachmentFilePatterns()

`CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.IncludeAttachmentFilePatterns`.

builder

@Stability(value=Stable)
static CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder builder()

Returns:

a CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder of CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty