Struct aws_sdk_kendra::types::ServiceNowKnowledgeArticleConfiguration

#[non_exhaustive]
pub struct ServiceNowKnowledgeArticleConfiguration {
    pub crawl_attachments: bool,
    pub include_attachment_file_patterns: Option<Vec<String>>,
    pub exclude_attachment_file_patterns: Option<Vec<String>>,
    pub document_data_field_name: String,
    pub document_title_field_name: Option<String>,
    pub field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub filter_query: Option<String>,
}

Provides the configuration information for crawling knowledge articles in the ServiceNow site.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

crawl_attachments: bool

TRUE to index attachments to knowledge articles.

include_attachment_file_patterns: Option<Vec<String>>

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.

exclude_attachment_file_patterns: Option<Vec<String>>

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.

document_data_field_name: String

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

document_title_field_name: Option<String>

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

field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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.

filter_query: Option<String>

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.

Implementations

impl ServiceNowKnowledgeArticleConfiguration

pub fn crawl_attachments(&self) -> bool

TRUE to index attachments to knowledge articles.

pub fn include_attachment_file_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .include_attachment_file_patterns.is_none().

pub fn exclude_attachment_file_patterns(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .exclude_attachment_file_patterns.is_none().

pub fn document_data_field_name(&self) -> &str

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

pub fn document_title_field_name(&self) -> Option<&str>

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

pub fn field_mappings(&self) -> &[DataSourceToIndexFieldMapping]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .field_mappings.is_none().

pub fn filter_query(&self) -> Option<&str>

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.

impl ServiceNowKnowledgeArticleConfiguration

pub fn builder() -> ServiceNowKnowledgeArticleConfigurationBuilder

Creates a new builder-style object to manufacture ServiceNowKnowledgeArticleConfiguration.

Trait Implementations

impl Clone for ServiceNowKnowledgeArticleConfiguration

fn clone(&self) -> ServiceNowKnowledgeArticleConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ServiceNowKnowledgeArticleConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ServiceNowKnowledgeArticleConfiguration

fn eq(&self, other: &ServiceNowKnowledgeArticleConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ServiceNowKnowledgeArticleConfiguration