ServiceNowKnowledgeArticleConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kendra.model.ServiceNowKnowledgeArticleConfiguration

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ServiceNowKnowledgeArticleConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides the configuration information for crawling knowledge articles in the ServiceNow site.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ServiceNowKnowledgeArticleConfiguration()

Constructors
Constructor and Description
`ServiceNowKnowledgeArticleConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ServiceNowKnowledgeArticleConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getCrawlAttachments()` `TRUE` to index attachments to knowledge articles.
`String`	`getDocumentDataFieldName()` The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
`String`	`getDocumentTitleFieldName()` The name of the ServiceNow field that is mapped to the index document title field.
`List<String>`	`getExcludeAttachmentFilePatterns()` A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.
`List<DataSourceToIndexFieldMapping>`	`getFieldMappings()` Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
`String`	`getFilterQuery()` A query that selects the knowledge articles to index.
`List<String>`	`getIncludeAttachmentFilePatterns()` A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.
`int`	`hashCode()`
`Boolean`	`isCrawlAttachments()` `TRUE` to index attachments to knowledge articles.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCrawlAttachments(Boolean crawlAttachments)` `TRUE` to index attachments to knowledge articles.
`void`	`setDocumentDataFieldName(String documentDataFieldName)` The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
`void`	`setDocumentTitleFieldName(String documentTitleFieldName)` The name of the ServiceNow field that is mapped to the index document title field.
`void`	`setExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)` A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.
`void`	`setFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
`void`	`setFilterQuery(String filterQuery)` A query that selects the knowledge articles to index.
`void`	`setIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)` A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.
`String`	`toString()` Returns a string representation of this object.
`ServiceNowKnowledgeArticleConfiguration`	`withCrawlAttachments(Boolean crawlAttachments)` `TRUE` to index attachments to knowledge articles.
`ServiceNowKnowledgeArticleConfiguration`	`withDocumentDataFieldName(String documentDataFieldName)` The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
`ServiceNowKnowledgeArticleConfiguration`	`withDocumentTitleFieldName(String documentTitleFieldName)` The name of the ServiceNow field that is mapped to the index document title field.
`ServiceNowKnowledgeArticleConfiguration`	`withExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)` A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.
`ServiceNowKnowledgeArticleConfiguration`	`withExcludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)` A list of regular expression patterns to exclude certain attachments of knowledge articles in your ServiceNow.
`ServiceNowKnowledgeArticleConfiguration`	`withFieldMappings(Collection<DataSourceToIndexFieldMapping> fieldMappings)` Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
`ServiceNowKnowledgeArticleConfiguration`	`withFieldMappings(DataSourceToIndexFieldMapping... fieldMappings)` Maps attributes or field names of knoweldge articles to Amazon Kendra index field names.
`ServiceNowKnowledgeArticleConfiguration`	`withFilterQuery(String filterQuery)` A query that selects the knowledge articles to index.
`ServiceNowKnowledgeArticleConfiguration`	`withIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)` A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.
`ServiceNowKnowledgeArticleConfiguration`	`withIncludeAttachmentFilePatterns(String... includeAttachmentFilePatterns)` A list of regular expression patterns to include certain attachments of knowledge articles in your ServiceNow.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ServiceNowKnowledgeArticleConfiguration
```
public ServiceNowKnowledgeArticleConfiguration()
```
- Method Detail
  - setCrawlAttachments
```
public void setCrawlAttachments(Boolean crawlAttachments)
```
    TRUE to index attachments to knowledge articles.
    
    Parameters:
    
    crawlAttachments - TRUE to index attachments to knowledge articles.
  - getCrawlAttachments
```
public Boolean getCrawlAttachments()
```
    TRUE to index attachments to knowledge articles.
    
    Returns:
    
    TRUE to index attachments to knowledge articles.
  - withCrawlAttachments
```
public ServiceNowKnowledgeArticleConfiguration withCrawlAttachments(Boolean crawlAttachments)
```
    TRUE to index attachments to knowledge articles.
    
    Parameters:
    
    crawlAttachments - TRUE to index attachments to knowledge articles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isCrawlAttachments
```
public Boolean isCrawlAttachments()
```
    TRUE to index attachments to knowledge articles.
    
    Returns:
    
    TRUE to index attachments to knowledge articles.
  - getIncludeAttachmentFilePatterns
```
public List<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.
    
    Returns:
    
    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.
  - setIncludeAttachmentFilePatterns
```
public void setIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
```
    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.
    
    Parameters:
    
    includeAttachmentFilePatterns - 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.
  - withIncludeAttachmentFilePatterns
```
public ServiceNowKnowledgeArticleConfiguration withIncludeAttachmentFilePatterns(String... includeAttachmentFilePatterns)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setIncludeAttachmentFilePatterns(java.util.Collection) or withIncludeAttachmentFilePatterns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    includeAttachmentFilePatterns - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIncludeAttachmentFilePatterns
```
public ServiceNowKnowledgeArticleConfiguration withIncludeAttachmentFilePatterns(Collection<String> includeAttachmentFilePatterns)
```
    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.
    
    Parameters:
    
    includeAttachmentFilePatterns - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExcludeAttachmentFilePatterns
```
public List<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.
    
    Returns:
    
    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.
  - setExcludeAttachmentFilePatterns
```
public void setExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
```
    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.
    
    Parameters:
    
    excludeAttachmentFilePatterns - 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.
  - withExcludeAttachmentFilePatterns
```
public ServiceNowKnowledgeArticleConfiguration withExcludeAttachmentFilePatterns(String... excludeAttachmentFilePatterns)
```
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setExcludeAttachmentFilePatterns(java.util.Collection) or withExcludeAttachmentFilePatterns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    excludeAttachmentFilePatterns - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withExcludeAttachmentFilePatterns
```
public ServiceNowKnowledgeArticleConfiguration withExcludeAttachmentFilePatterns(Collection<String> excludeAttachmentFilePatterns)
```
    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.
    
    Parameters:
    
    excludeAttachmentFilePatterns - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentDataFieldName
```
public void setDocumentDataFieldName(String documentDataFieldName)
```
    The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
    
    Parameters:
    
    documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
  - getDocumentDataFieldName
```
public String getDocumentDataFieldName()
```
    The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
    
    Returns:
    
    The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
  - withDocumentDataFieldName
```
public ServiceNowKnowledgeArticleConfiguration withDocumentDataFieldName(String documentDataFieldName)
```
    The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
    
    Parameters:
    
    documentDataFieldName - The name of the ServiceNow field that is mapped to the index document contents field in the Amazon Kendra index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentTitleFieldName
```
public void setDocumentTitleFieldName(String documentTitleFieldName)
```
    The name of the ServiceNow field that is mapped to the index document title field.
    
    Parameters:
    
    documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.
  - getDocumentTitleFieldName
```
public String getDocumentTitleFieldName()
```
    The name of the ServiceNow field that is mapped to the index document title field.
    
    Returns:
    
    The name of the ServiceNow field that is mapped to the index document title field.
  - withDocumentTitleFieldName
```
public ServiceNowKnowledgeArticleConfiguration withDocumentTitleFieldName(String documentTitleFieldName)
```
    The name of the ServiceNow field that is mapped to the index document title field.
    
    Parameters:
    
    documentTitleFieldName - The name of the ServiceNow field that is mapped to the index document title field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFieldMappings
```
public List<DataSourceToIndexFieldMapping> 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.
    
    Returns:
    
    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.
  - setFieldMappings
```
public void setFieldMappings(Collection<DataSourceToIndexFieldMapping> 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.
    
    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.
  - withFieldMappings
```
public ServiceNowKnowledgeArticleConfiguration withFieldMappings(DataSourceToIndexFieldMapping... 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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFieldMappings(java.util.Collection) or withFieldMappings(java.util.Collection) if you want to override the existing values.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFieldMappings
```
public ServiceNowKnowledgeArticleConfiguration withFieldMappings(Collection<DataSourceToIndexFieldMapping> 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFilterQuery
```
public void setFilterQuery(String 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.
    
    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.
  - getFilterQuery
```
public 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.
    
    Returns:
    
    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.
  - withFilterQuery
```
public ServiceNowKnowledgeArticleConfiguration withFilterQuery(String 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ServiceNowKnowledgeArticleConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ServiceNowKnowledgeArticleConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceNowKnowledgeArticleConfiguration

Method Detail

setCrawlAttachments

getCrawlAttachments

withCrawlAttachments

isCrawlAttachments

getIncludeAttachmentFilePatterns

setIncludeAttachmentFilePatterns

withIncludeAttachmentFilePatterns

withIncludeAttachmentFilePatterns

getExcludeAttachmentFilePatterns

setExcludeAttachmentFilePatterns

withExcludeAttachmentFilePatterns

withExcludeAttachmentFilePatterns

setDocumentDataFieldName

getDocumentDataFieldName

withDocumentDataFieldName

setDocumentTitleFieldName

getDocumentTitleFieldName

withDocumentTitleFieldName

getFieldMappings

setFieldMappings

withFieldMappings

withFieldMappings

setFilterQuery

getFilterQuery

withFilterQuery

toString

equals

hashCode

clone

marshall