#[non_exhaustive]pub struct ConfluenceSpaceConfigurationBuilder { /* private fields */ }Expand description
A builder for ConfluenceSpaceConfiguration.
Implementations§
Source§impl ConfluenceSpaceConfigurationBuilder
impl ConfluenceSpaceConfigurationBuilder
Sourcepub fn crawl_personal_spaces(self, input: bool) -> Self
pub fn crawl_personal_spaces(self, input: bool) -> Self
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
Sourcepub fn set_crawl_personal_spaces(self, input: Option<bool>) -> Self
pub fn set_crawl_personal_spaces(self, input: Option<bool>) -> Self
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
Sourcepub fn get_crawl_personal_spaces(&self) -> &Option<bool>
pub fn get_crawl_personal_spaces(&self) -> &Option<bool>
TRUE to index personal spaces. You can add restrictions to items in personal spaces. If personal spaces are indexed, queries without user context information may return restricted items from a personal space in their results. For more information, see Filtering on user context.
Sourcepub fn crawl_archived_spaces(self, input: bool) -> Self
pub fn crawl_archived_spaces(self, input: bool) -> Self
TRUE to index archived spaces.
Sourcepub fn set_crawl_archived_spaces(self, input: Option<bool>) -> Self
pub fn set_crawl_archived_spaces(self, input: Option<bool>) -> Self
TRUE to index archived spaces.
Sourcepub fn get_crawl_archived_spaces(&self) -> &Option<bool>
pub fn get_crawl_archived_spaces(&self) -> &Option<bool>
TRUE to index archived spaces.
Sourcepub fn include_spaces(self, input: impl Into<String>) -> Self
pub fn include_spaces(self, input: impl Into<String>) -> Self
Appends an item to include_spaces.
To override the contents of this collection use set_include_spaces.
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
Sourcepub fn set_include_spaces(self, input: Option<Vec<String>>) -> Self
pub fn set_include_spaces(self, input: Option<Vec<String>>) -> Self
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
Sourcepub fn get_include_spaces(&self) -> &Option<Vec<String>>
pub fn get_include_spaces(&self) -> &Option<Vec<String>>
A list of space keys for Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are indexed. Spaces that aren't in the list aren't indexed. A space in the list must exist. Otherwise, Amazon Kendra logs an error when the data source is synchronized. If a space is in both the IncludeSpaces and the ExcludeSpaces list, the space is excluded.
Sourcepub fn exclude_spaces(self, input: impl Into<String>) -> Self
pub fn exclude_spaces(self, input: impl Into<String>) -> Self
Appends an item to exclude_spaces.
To override the contents of this collection use set_exclude_spaces.
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
Sourcepub fn set_exclude_spaces(self, input: Option<Vec<String>>) -> Self
pub fn set_exclude_spaces(self, input: Option<Vec<String>>) -> Self
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
Sourcepub fn get_exclude_spaces(&self) -> &Option<Vec<String>>
pub fn get_exclude_spaces(&self) -> &Option<Vec<String>>
A list of space keys of Confluence spaces. If you include a key, the blogs, documents, and attachments in the space are not indexed. If a space is in both the ExcludeSpaces and the IncludeSpaces list, the space is excluded.
Sourcepub fn space_field_mappings(
self,
input: ConfluenceSpaceToIndexFieldMapping,
) -> Self
pub fn space_field_mappings( self, input: ConfluenceSpaceToIndexFieldMapping, ) -> Self
Appends an item to space_field_mappings.
To override the contents of this collection use set_space_field_mappings.
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
Sourcepub fn set_space_field_mappings(
self,
input: Option<Vec<ConfluenceSpaceToIndexFieldMapping>>,
) -> Self
pub fn set_space_field_mappings( self, input: Option<Vec<ConfluenceSpaceToIndexFieldMapping>>, ) -> Self
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
Sourcepub fn get_space_field_mappings(
&self,
) -> &Option<Vec<ConfluenceSpaceToIndexFieldMapping>>
pub fn get_space_field_mappings( &self, ) -> &Option<Vec<ConfluenceSpaceToIndexFieldMapping>>
Maps attributes or field names of Confluence spaces to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Confluence fields. For more information, see Mapping data source fields. The Confluence data source field names must exist in your Confluence custom metadata.
If you specify the SpaceFieldMappings parameter, you must specify at least one field mapping.
Sourcepub fn build(self) -> ConfluenceSpaceConfiguration
pub fn build(self) -> ConfluenceSpaceConfiguration
Consumes the builder and constructs a ConfluenceSpaceConfiguration.
Trait Implementations§
Source§impl Clone for ConfluenceSpaceConfigurationBuilder
impl Clone for ConfluenceSpaceConfigurationBuilder
Source§fn clone(&self) -> ConfluenceSpaceConfigurationBuilder
fn clone(&self) -> ConfluenceSpaceConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for ConfluenceSpaceConfigurationBuilder
impl Default for ConfluenceSpaceConfigurationBuilder
Source§fn default() -> ConfluenceSpaceConfigurationBuilder
fn default() -> ConfluenceSpaceConfigurationBuilder
Source§impl PartialEq for ConfluenceSpaceConfigurationBuilder
impl PartialEq for ConfluenceSpaceConfigurationBuilder
Source§fn eq(&self, other: &ConfluenceSpaceConfigurationBuilder) -> bool
fn eq(&self, other: &ConfluenceSpaceConfigurationBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for ConfluenceSpaceConfigurationBuilder
Auto Trait Implementations§
impl Freeze for ConfluenceSpaceConfigurationBuilder
impl RefUnwindSafe for ConfluenceSpaceConfigurationBuilder
impl Send for ConfluenceSpaceConfigurationBuilder
impl Sync for ConfluenceSpaceConfigurationBuilder
impl Unpin for ConfluenceSpaceConfigurationBuilder
impl UnwindSafe for ConfluenceSpaceConfigurationBuilder
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);