/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Provides the configuration information for crawling knowledge articles in the
* ServiceNow site.See Also:
AWS
* API Reference
TRUE
to index attachments to knowledge articles.
TRUE
to index attachments to knowledge articles.
TRUE
to index attachments to knowledge articles.
TRUE
to index attachments to knowledge articles.
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.
*/ inline const Aws::VectorA 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.
*/ inline bool IncludeAttachmentFilePatternsHasBeenSet() const { return m_includeAttachmentFilePatternsHasBeenSet; } /** *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.
*/ inline void SetIncludeAttachmentFilePatterns(const Aws::VectorA 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.
*/ inline void SetIncludeAttachmentFilePatterns(Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithIncludeAttachmentFilePatterns(const Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithIncludeAttachmentFilePatterns(Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddIncludeAttachmentFilePatterns(const Aws::String& value) { m_includeAttachmentFilePatternsHasBeenSet = true; m_includeAttachmentFilePatterns.push_back(value); return *this; } /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddIncludeAttachmentFilePatterns(Aws::String&& value) { m_includeAttachmentFilePatternsHasBeenSet = true; m_includeAttachmentFilePatterns.push_back(std::move(value)); return *this; } /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddIncludeAttachmentFilePatterns(const char* value) { m_includeAttachmentFilePatternsHasBeenSet = true; m_includeAttachmentFilePatterns.push_back(value); return *this; } /** *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.
*/ inline const Aws::VectorA 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.
*/ inline bool ExcludeAttachmentFilePatternsHasBeenSet() const { return m_excludeAttachmentFilePatternsHasBeenSet; } /** *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.
*/ inline void SetExcludeAttachmentFilePatterns(const Aws::VectorA 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.
*/ inline void SetExcludeAttachmentFilePatterns(Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithExcludeAttachmentFilePatterns(const Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithExcludeAttachmentFilePatterns(Aws::VectorA 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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddExcludeAttachmentFilePatterns(const Aws::String& value) { m_excludeAttachmentFilePatternsHasBeenSet = true; m_excludeAttachmentFilePatterns.push_back(value); return *this; } /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddExcludeAttachmentFilePatterns(Aws::String&& value) { m_excludeAttachmentFilePatternsHasBeenSet = true; m_excludeAttachmentFilePatterns.push_back(std::move(value)); return *this; } /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& AddExcludeAttachmentFilePatterns(const char* value) { m_excludeAttachmentFilePatternsHasBeenSet = true; m_excludeAttachmentFilePatterns.push_back(value); return *this; } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline const Aws::String& GetDocumentDataFieldName() const{ return m_documentDataFieldName; } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline bool DocumentDataFieldNameHasBeenSet() const { return m_documentDataFieldNameHasBeenSet; } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline void SetDocumentDataFieldName(const Aws::String& value) { m_documentDataFieldNameHasBeenSet = true; m_documentDataFieldName = value; } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline void SetDocumentDataFieldName(Aws::String&& value) { m_documentDataFieldNameHasBeenSet = true; m_documentDataFieldName = std::move(value); } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline void SetDocumentDataFieldName(const char* value) { m_documentDataFieldNameHasBeenSet = true; m_documentDataFieldName.assign(value); } /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentDataFieldName(const Aws::String& value) { SetDocumentDataFieldName(value); return *this;} /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentDataFieldName(Aws::String&& value) { SetDocumentDataFieldName(std::move(value)); return *this;} /** *The name of the ServiceNow field that is mapped to the index document * contents field in the Amazon Kendra index.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentDataFieldName(const char* value) { SetDocumentDataFieldName(value); return *this;} /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline const Aws::String& GetDocumentTitleFieldName() const{ return m_documentTitleFieldName; } /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline bool DocumentTitleFieldNameHasBeenSet() const { return m_documentTitleFieldNameHasBeenSet; } /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline void SetDocumentTitleFieldName(const Aws::String& value) { m_documentTitleFieldNameHasBeenSet = true; m_documentTitleFieldName = value; } /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline void SetDocumentTitleFieldName(Aws::String&& value) { m_documentTitleFieldNameHasBeenSet = true; m_documentTitleFieldName = std::move(value); } /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline void SetDocumentTitleFieldName(const char* value) { m_documentTitleFieldNameHasBeenSet = true; m_documentTitleFieldName.assign(value); } /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentTitleFieldName(const Aws::String& value) { SetDocumentTitleFieldName(value); return *this;} /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentTitleFieldName(Aws::String&& value) { SetDocumentTitleFieldName(std::move(value)); return *this;} /** *The name of the ServiceNow field that is mapped to the index document title * field.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithDocumentTitleFieldName(const char* value) { SetDocumentTitleFieldName(value); return *this;} /** *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.
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.
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.
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.
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.
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.
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.
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.
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.
*/ inline const Aws::String& GetFilterQuery() const{ return m_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.
*/ inline bool FilterQueryHasBeenSet() const { return m_filterQueryHasBeenSet; } /** *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.
*/ inline void SetFilterQuery(const Aws::String& value) { m_filterQueryHasBeenSet = true; m_filterQuery = value; } /** *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.
*/ inline void SetFilterQuery(Aws::String&& value) { m_filterQueryHasBeenSet = true; m_filterQuery = std::move(value); } /** *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.
*/ inline void SetFilterQuery(const char* value) { m_filterQueryHasBeenSet = true; m_filterQuery.assign(value); } /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithFilterQuery(const Aws::String& value) { SetFilterQuery(value); return *this;} /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithFilterQuery(Aws::String&& value) { SetFilterQuery(std::move(value)); return *this;} /** *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.
*/ inline ServiceNowKnowledgeArticleConfiguration& WithFilterQuery(const char* value) { SetFilterQuery(value); return *this;} private: bool m_crawlAttachments; bool m_crawlAttachmentsHasBeenSet = false; Aws::Vector