Struct aws_sdk_kendra::types::ConfluenceSpaceConfiguration

#[non_exhaustive]
pub struct ConfluenceSpaceConfiguration {
    pub crawl_personal_spaces: bool,
    pub crawl_archived_spaces: bool,
    pub include_spaces: Option<Vec<String>>,
    pub exclude_spaces: Option<Vec<String>>,
    pub space_field_mappings: Option<Vec<ConfluenceSpaceToIndexFieldMapping>>,
}

Configuration information for indexing Confluence spaces.

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_personal_spaces: 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.

crawl_archived_spaces: bool

TRUE to index archived spaces.

include_spaces: 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.

exclude_spaces: 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.

space_field_mappings: 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.

Implementations

impl ConfluenceSpaceConfiguration

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

pub fn crawl_archived_spaces(&self) -> bool

TRUE to index archived spaces.

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

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_spaces.is_none().

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

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_spaces.is_none().

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

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

impl ConfluenceSpaceConfiguration

pub fn builder() -> ConfluenceSpaceConfigurationBuilder

Creates a new builder-style object to manufacture ConfluenceSpaceConfiguration.

Trait Implementations

impl Clone for ConfluenceSpaceConfiguration

fn clone(&self) -> ConfluenceSpaceConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfluenceSpaceConfiguration

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

Formats the value using the given formatter.

impl PartialEq for ConfluenceSpaceConfiguration

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