Struct QuipConfiguration 

#[non_exhaustive]
pub struct QuipConfiguration {
    pub domain: String,
    pub secret_arn: String,
    pub crawl_file_comments: bool,
    pub crawl_chat_rooms: bool,
    pub crawl_attachments: bool,
    pub folder_ids: Option<Vec<String>>,
    pub thread_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub message_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub attachment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>,
    pub inclusion_patterns: Option<Vec<String>>,
    pub exclusion_patterns: Option<Vec<String>>,
    pub vpc_configuration: Option<DataSourceVpcConfiguration>,
}

Provides the configuration information to connect to Quip as your data source.

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.

domain: String

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

secret_arn: String

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

• accessToken—The token created in Quip. For more information, see Using a Quip data source.

crawl_file_comments: bool

TRUE to index file comments.

crawl_chat_rooms: bool

TRUE to index the contents of chat rooms.

crawl_attachments: bool

TRUE to index attachments.

folder_ids: Option<Vec<String>>

The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".

thread_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

message_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

attachment_field_mappings: Option<Vec<DataSourceToIndexFieldMapping>>

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

inclusion_patterns: Option<Vec<String>>

A list of regular expression patterns to include certain files in your Quip file system. 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 pattern and an 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 Quip file system. 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 pattern and an exclusion pattern, the exclusion pattern takes precedence, and the file isn't included in the index.

vpc_configuration: Option<DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

Implementations

impl QuipConfiguration

pub fn domain(&self) -> &str

The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".

pub fn secret_arn(&self) -> &str

The Amazon Resource Name (ARN) of an Secrets Manager secret that contains the key-value pairs that are required to connect to your Quip. The secret must contain a JSON structure with the following keys:

• accessToken—The token created in Quip. For more information, see Using a Quip data source.

pub fn crawl_file_comments(&self) -> bool

TRUE to index file comments.

pub fn crawl_chat_rooms(&self) -> bool

TRUE to index the contents of chat rooms.

pub fn crawl_attachments(&self) -> bool

TRUE to index attachments.

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

The identifiers of the Quip folders you want to index. You can find the folder ID in your browser URL when you access your folder in Quip. For example, https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name. The folder ID in this example is "zlLuOVNSarTL".

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

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

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

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

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

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

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

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

A list of regular expression patterns to include certain files in your Quip file system. 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 pattern and an 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 Quip file system. 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 pattern and an 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 vpc_configuration(&self) -> Option<&DataSourceVpcConfiguration>

Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.

impl QuipConfiguration

pub fn builder() -> QuipConfigurationBuilder

Creates a new builder-style object to manufacture QuipConfiguration.

Trait Implementations

impl Clone for QuipConfiguration

fn clone(&self) -> QuipConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuipConfiguration

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

Formats the value using the given formatter.

impl PartialEq for QuipConfiguration

fn eq(&self, other: &QuipConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QuipConfiguration