#[non_exhaustive]pub struct ServiceNowKnowledgeArticleConfigurationBuilder { /* private fields */ }Expand description
A builder for ServiceNowKnowledgeArticleConfiguration.
Implementations§
Source§impl ServiceNowKnowledgeArticleConfigurationBuilder
impl ServiceNowKnowledgeArticleConfigurationBuilder
Sourcepub fn crawl_attachments(self, input: bool) -> Self
pub fn crawl_attachments(self, input: bool) -> Self
TRUE to index attachments to knowledge articles.
Sourcepub fn set_crawl_attachments(self, input: Option<bool>) -> Self
pub fn set_crawl_attachments(self, input: Option<bool>) -> Self
TRUE to index attachments to knowledge articles.
Sourcepub fn get_crawl_attachments(&self) -> &Option<bool>
pub fn get_crawl_attachments(&self) -> &Option<bool>
TRUE to index attachments to knowledge articles.
Sourcepub fn include_attachment_file_patterns(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_include_attachment_file_patterns(
self,
input: Option<Vec<String>>,
) -> Self
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.
Sourcepub fn get_include_attachment_file_patterns(&self) -> &Option<Vec<String>>
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.
Sourcepub fn exclude_attachment_file_patterns(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_exclude_attachment_file_patterns(
self,
input: Option<Vec<String>>,
) -> Self
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.
Sourcepub fn get_exclude_attachment_file_patterns(&self) -> &Option<Vec<String>>
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.
Sourcepub fn document_data_field_name(self, input: impl Into<String>) -> Self
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.Sourcepub fn set_document_data_field_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_document_data_field_name(&self) -> &Option<String>
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.
Sourcepub fn document_title_field_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_document_title_field_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_document_title_field_name(&self) -> &Option<String>
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.
Sourcepub fn field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self
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.
Sourcepub fn set_field_mappings(
self,
input: Option<Vec<DataSourceToIndexFieldMapping>>,
) -> Self
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.
Sourcepub fn get_field_mappings(&self) -> &Option<Vec<DataSourceToIndexFieldMapping>>
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.
Sourcepub fn filter_query(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_filter_query(self, input: Option<String>) -> Self
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.
Sourcepub fn get_filter_query(&self) -> &Option<String>
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.
Sourcepub fn build(
self,
) -> Result<ServiceNowKnowledgeArticleConfiguration, BuildError>
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:
Trait Implementations§
Source§impl Clone for ServiceNowKnowledgeArticleConfigurationBuilder
impl Clone for ServiceNowKnowledgeArticleConfigurationBuilder
Source§fn clone(&self) -> ServiceNowKnowledgeArticleConfigurationBuilder
fn clone(&self) -> ServiceNowKnowledgeArticleConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for ServiceNowKnowledgeArticleConfigurationBuilder
impl Default for ServiceNowKnowledgeArticleConfigurationBuilder
Source§fn default() -> ServiceNowKnowledgeArticleConfigurationBuilder
fn default() -> ServiceNowKnowledgeArticleConfigurationBuilder
Source§impl PartialEq for ServiceNowKnowledgeArticleConfigurationBuilder
impl PartialEq for ServiceNowKnowledgeArticleConfigurationBuilder
Source§fn eq(&self, other: &ServiceNowKnowledgeArticleConfigurationBuilder) -> bool
fn eq(&self, other: &ServiceNowKnowledgeArticleConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ServiceNowKnowledgeArticleConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ServiceNowKnowledgeArticleConfigurationBuilder
impl RefUnwindSafe for ServiceNowKnowledgeArticleConfigurationBuilder
impl Send for ServiceNowKnowledgeArticleConfigurationBuilder
impl Sync for ServiceNowKnowledgeArticleConfigurationBuilder
impl Unpin for ServiceNowKnowledgeArticleConfigurationBuilder
impl UnwindSafe for ServiceNowKnowledgeArticleConfigurationBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);