Package software.amazon.awscdk.services.kendra

Class CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy

All Implemented Interfaces:

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

@Stability(Stable)
@Internal
public static final class CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

An implementation for CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.kendra.CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder, CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getCrawlAttachments()	TRUE to index attachments to knowledge articles.
final String	getDocumentDataFieldName()	The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
final String	getDocumentTitleFieldName()	The name of the ServiceNow field that is mapped to the index document title field.
final List<String>	getExcludeAttachmentFilePatterns()	A list of regular expression patterns applied to exclude certain knowledge article attachments.
final Object	getFieldMappings()	Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
final String	getFilterQuery()	A query that selects the knowledge articles to index.
final List<String>	getIncludeAttachmentFilePatterns()	A list of regular expression patterns applied to include knowledge article attachments.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty.Builder.

Method Details

getDocumentDataFieldName

public final String getDocumentDataFieldName()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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

Specified by:

getDocumentDataFieldName in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documentdatafieldname

getCrawlAttachments

public final Object getCrawlAttachments()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

TRUE to index attachments to knowledge articles.

Returns union: either Boolean or IResolvable

Specified by:

getCrawlAttachments in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-crawlattachments

getDocumentTitleFieldName

public final String getDocumentTitleFieldName()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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

Specified by:

getDocumentTitleFieldName in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-documenttitlefieldname

getExcludeAttachmentFilePatterns

public final List<String> getExcludeAttachmentFilePatterns()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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.

Specified by:

getExcludeAttachmentFilePatterns in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-excludeattachmentfilepatterns

getFieldMappings

public final Object getFieldMappings()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSource.DataSourceToIndexFieldMappingProperty>

Specified by:

getFieldMappings in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-fieldmappings

getFilterQuery

public final String getFilterQuery()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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 .

Specified by:

getFilterQuery in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-filterquery

getIncludeAttachmentFilePatterns

public final List<String> getIncludeAttachmentFilePatterns()

Description copied from interface: CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

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.

Specified by:

getIncludeAttachmentFilePatterns in interface CfnDataSource.ServiceNowKnowledgeArticleConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-servicenowknowledgearticleconfiguration.html#cfn-kendra-datasource-servicenowknowledgearticleconfiguration-includeattachmentfilepatterns

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object