Struct aws_sdk_kendra::types::builders::ServiceNowKnowledgeArticleConfigurationBuilder

#[non_exhaustive]
pub struct ServiceNowKnowledgeArticleConfigurationBuilder { /* private fields */ }

A builder for ServiceNowKnowledgeArticleConfiguration.

Implementations

impl ServiceNowKnowledgeArticleConfigurationBuilder

pub fn crawl_attachments(self, input: bool) -> Self

TRUE to index attachments to knowledge articles.

pub fn set_crawl_attachments(self, input: Option<bool>) -> Self

TRUE to index attachments to knowledge articles.

pub fn get_crawl_attachments(&self) -> &Option<bool>

TRUE to index attachments to knowledge articles.

pub fn include_attachment_file_patterns(self, input: impl Into<String>) -> Self

Appends an item to include_attachment_file_patterns.

To override the contents of this collection use set_include_attachment_file_patterns.

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.

pub fn set_include_attachment_file_patterns( self, input: Option<Vec<String>> ) -> Self

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.

pub fn get_include_attachment_file_patterns(&self) -> &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.

pub fn exclude_attachment_file_patterns(self, input: impl Into<String>) -> Self

Appends an item to exclude_attachment_file_patterns.

To override the contents of this collection use set_exclude_attachment_file_patterns.

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.

pub fn set_exclude_attachment_file_patterns( self, input: Option<Vec<String>> ) -> Self

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.

pub fn get_exclude_attachment_file_patterns(&self) -> &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.

pub fn document_data_field_name(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_document_data_field_name(self, input: Option<String>) -> Self

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

pub fn get_document_data_field_name(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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

pub fn set_document_title_field_name(self, input: Option<String>) -> Self

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

pub fn get_document_title_field_name(&self) -> &Option<String>

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

pub fn field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self

Appends an item to field_mappings.

To override the contents of this collection use set_field_mappings.

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.

pub fn set_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>> ) -> Self

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.

pub fn get_field_mappings(&self) -> &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.

pub fn filter_query(self, input: impl Into<String>) -> Self

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.

pub fn set_filter_query(self, input: Option<String>) -> Self

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.

pub fn get_filter_query(&self) -> &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.

pub fn build( self ) -> Result<ServiceNowKnowledgeArticleConfiguration, BuildError>

Consumes the builder and constructs a ServiceNowKnowledgeArticleConfiguration. This method will fail if any of the following fields are not set:

• document_data_field_name

Trait Implementations

impl Clone for ServiceNowKnowledgeArticleConfigurationBuilder

fn clone(&self) -> ServiceNowKnowledgeArticleConfigurationBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServiceNowKnowledgeArticleConfigurationBuilder

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

Formats the value using the given formatter.

impl Default for ServiceNowKnowledgeArticleConfigurationBuilder

fn default() -> ServiceNowKnowledgeArticleConfigurationBuilder

Returns the “default value” for a type.

impl PartialEq for ServiceNowKnowledgeArticleConfigurationBuilder

fn eq(&self, other: &ServiceNowKnowledgeArticleConfigurationBuilder) -> 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 ServiceNowKnowledgeArticleConfigurationBuilder