Struct aws_sdk_kendra::types::WorkDocsConfiguration

#[non_exhaustive]
pub struct WorkDocsConfiguration {
    pub organization_id: String,
    pub crawl_comments: bool,
    pub use_change_log: bool,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
}

Provides the configuration information to connect to Amazon WorkDocs as your data source.

Amazon WorkDocs connector is available in Oregon, North Virginia, Sydney, Singapore and Ireland regions.

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.

organization_id: String

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

crawl_comments: bool

TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE.

use_change_log: bool

TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

inclusion_patterns: Option<Vec<String>>

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

exclusion_patterns: Option<Vec<String>>

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file isn't included in the index.

field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs custom metadata.

Implementations

impl WorkDocsConfiguration

pub fn organization_id(&self) -> &str

The identifier of the directory corresponding to your Amazon WorkDocs site repository.

You can find the organization ID in the Directory Service by going to Active Directory, then Directories. Your Amazon WorkDocs site directory has an ID, which is the organization ID. You can also set up a new Amazon WorkDocs directory in the Directory Service console and enable a Amazon WorkDocs site for the directory in the Amazon WorkDocs console.

pub fn crawl_comments(&self) -> bool

TRUE to include comments on documents in your index. Including comments in your index means each comment is a document that can be searched on.

The default is set to FALSE.

pub fn use_change_log(&self) -> bool

TRUE to use the Amazon WorkDocs change log to determine which documents require updating in the index. Depending on the change log's size, it may take longer for Amazon Kendra to use the change log than to scan all of your documents in Amazon WorkDocs.

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

A list of regular expression patterns to include certain files in your Amazon WorkDocs site repository. Files that match the patterns are included in the index. Files that don't match the patterns are excluded from the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file 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 .inclusion_patterns.is_none().

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

A list of regular expression patterns to exclude certain files in your Amazon WorkDocs site repository. Files that match the patterns are excluded from the index. Files that don’t match the patterns are included in the index. If a file matches both an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file 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 .exclusion_patterns.is_none().

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

A list of DataSourceToIndexFieldMapping objects that map Amazon WorkDocs data source attributes or field names to Amazon Kendra index field names. To create custom fields, use the UpdateIndex API before you map to Amazon WorkDocs fields. For more information, see Mapping data source fields. The Amazon WorkDocs data source field names must exist in your Amazon WorkDocs 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().

impl WorkDocsConfiguration

pub fn builder() -> WorkDocsConfigurationBuilder

Creates a new builder-style object to manufacture WorkDocsConfiguration.

Trait Implementations

impl Clone for WorkDocsConfiguration

fn clone(&self) -> WorkDocsConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkDocsConfiguration

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

Formats the value using the given formatter.

impl PartialEq for WorkDocsConfiguration

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