#[non_exhaustive]pub struct QuipConfigurationBuilder { /* private fields */ }Expand description
A builder for QuipConfiguration.
Implementations§
Source§impl QuipConfigurationBuilder
impl QuipConfigurationBuilder
Sourcepub fn domain(self, input: impl Into<String>) -> Self
pub fn domain(self, input: impl Into<String>) -> Self
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
This field is required.Sourcepub fn set_domain(self, input: Option<String>) -> Self
pub fn set_domain(self, input: Option<String>) -> Self
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
Sourcepub fn get_domain(&self) -> &Option<String>
pub fn get_domain(&self) -> &Option<String>
The Quip site domain. For example, https://quip-company.quipdomain.com/browse. The domain in this example is "quipdomain".
Sourcepub fn secret_arn(self, input: impl Into<String>) -> Self
pub fn secret_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_secret_arn(self, input: Option<String>) -> Self
pub fn set_secret_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_secret_arn(&self) -> &Option<String>
pub fn get_secret_arn(&self) -> &Option<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.
Sourcepub fn crawl_file_comments(self, input: bool) -> Self
pub fn crawl_file_comments(self, input: bool) -> Self
TRUE to index file comments.
Sourcepub fn set_crawl_file_comments(self, input: Option<bool>) -> Self
pub fn set_crawl_file_comments(self, input: Option<bool>) -> Self
TRUE to index file comments.
Sourcepub fn get_crawl_file_comments(&self) -> &Option<bool>
pub fn get_crawl_file_comments(&self) -> &Option<bool>
TRUE to index file comments.
Sourcepub fn crawl_chat_rooms(self, input: bool) -> Self
pub fn crawl_chat_rooms(self, input: bool) -> Self
TRUE to index the contents of chat rooms.
Sourcepub fn set_crawl_chat_rooms(self, input: Option<bool>) -> Self
pub fn set_crawl_chat_rooms(self, input: Option<bool>) -> Self
TRUE to index the contents of chat rooms.
Sourcepub fn get_crawl_chat_rooms(&self) -> &Option<bool>
pub fn get_crawl_chat_rooms(&self) -> &Option<bool>
TRUE to index the contents of chat rooms.
Sourcepub fn crawl_attachments(self, input: bool) -> Self
pub fn crawl_attachments(self, input: bool) -> Self
TRUE to index attachments.
Sourcepub fn set_crawl_attachments(self, input: Option<bool>) -> Self
pub fn set_crawl_attachments(self, input: Option<bool>) -> Self
TRUE to index attachments.
Sourcepub fn get_crawl_attachments(&self) -> &Option<bool>
pub fn get_crawl_attachments(&self) -> &Option<bool>
TRUE to index attachments.
Sourcepub fn folder_ids(self, input: impl Into<String>) -> Self
pub fn folder_ids(self, input: impl Into<String>) -> Self
Appends an item to folder_ids.
To override the contents of this collection use set_folder_ids.
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".
Sourcepub fn set_folder_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_folder_ids(self, input: Option<Vec<String>>) -> Self
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".
Sourcepub fn get_folder_ids(&self) -> &Option<Vec<String>>
pub fn get_folder_ids(&self) -> &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".
Sourcepub fn thread_field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self
pub fn thread_field_mappings(self, input: DataSourceToIndexFieldMapping) -> Self
Appends an item to thread_field_mappings.
To override the contents of this collection use set_thread_field_mappings.
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.
Sourcepub fn set_thread_field_mappings(
self,
input: Option<Vec<DataSourceToIndexFieldMapping>>,
) -> Self
pub fn set_thread_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self
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.
Sourcepub fn get_thread_field_mappings(
&self,
) -> &Option<Vec<DataSourceToIndexFieldMapping>>
pub fn get_thread_field_mappings( &self, ) -> &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.
Sourcepub fn message_field_mappings(
self,
input: DataSourceToIndexFieldMapping,
) -> Self
pub fn message_field_mappings( self, input: DataSourceToIndexFieldMapping, ) -> Self
Appends an item to message_field_mappings.
To override the contents of this collection use set_message_field_mappings.
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.
Sourcepub fn set_message_field_mappings(
self,
input: Option<Vec<DataSourceToIndexFieldMapping>>,
) -> Self
pub fn set_message_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self
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.
Sourcepub fn get_message_field_mappings(
&self,
) -> &Option<Vec<DataSourceToIndexFieldMapping>>
pub fn get_message_field_mappings( &self, ) -> &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.
Sourcepub fn attachment_field_mappings(
self,
input: DataSourceToIndexFieldMapping,
) -> Self
pub fn attachment_field_mappings( self, input: DataSourceToIndexFieldMapping, ) -> Self
Appends an item to attachment_field_mappings.
To override the contents of this collection use set_attachment_field_mappings.
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.
Sourcepub fn set_attachment_field_mappings(
self,
input: Option<Vec<DataSourceToIndexFieldMapping>>,
) -> Self
pub fn set_attachment_field_mappings( self, input: Option<Vec<DataSourceToIndexFieldMapping>>, ) -> Self
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.
Sourcepub fn get_attachment_field_mappings(
&self,
) -> &Option<Vec<DataSourceToIndexFieldMapping>>
pub fn get_attachment_field_mappings( &self, ) -> &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.
Sourcepub fn inclusion_patterns(self, input: impl Into<String>) -> Self
pub fn inclusion_patterns(self, input: impl Into<String>) -> Self
Appends an item to inclusion_patterns.
To override the contents of this collection use set_inclusion_patterns.
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.
Sourcepub fn set_inclusion_patterns(self, input: Option<Vec<String>>) -> Self
pub fn set_inclusion_patterns(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_inclusion_patterns(&self) -> &Option<Vec<String>>
pub fn get_inclusion_patterns(&self) -> &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.
Sourcepub fn exclusion_patterns(self, input: impl Into<String>) -> Self
pub fn exclusion_patterns(self, input: impl Into<String>) -> Self
Appends an item to exclusion_patterns.
To override the contents of this collection use set_exclusion_patterns.
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.
Sourcepub fn set_exclusion_patterns(self, input: Option<Vec<String>>) -> Self
pub fn set_exclusion_patterns(self, input: Option<Vec<String>>) -> Self
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.
Sourcepub fn get_exclusion_patterns(&self) -> &Option<Vec<String>>
pub fn get_exclusion_patterns(&self) -> &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.
Sourcepub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self
pub fn vpc_configuration(self, input: DataSourceVpcConfiguration) -> Self
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
Sourcepub fn set_vpc_configuration(
self,
input: Option<DataSourceVpcConfiguration>,
) -> Self
pub fn set_vpc_configuration( self, input: Option<DataSourceVpcConfiguration>, ) -> Self
Configuration information for an Amazon Virtual Private Cloud (VPC) to connect to your Quip. For more information, see Configuring a VPC.
Sourcepub fn get_vpc_configuration(&self) -> &Option<DataSourceVpcConfiguration>
pub fn get_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.
Sourcepub fn build(self) -> Result<QuipConfiguration, BuildError>
pub fn build(self) -> Result<QuipConfiguration, BuildError>
Consumes the builder and constructs a QuipConfiguration.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for QuipConfigurationBuilder
impl Clone for QuipConfigurationBuilder
Source§fn clone(&self) -> QuipConfigurationBuilder
fn clone(&self) -> QuipConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for QuipConfigurationBuilder
impl Debug for QuipConfigurationBuilder
Source§impl Default for QuipConfigurationBuilder
impl Default for QuipConfigurationBuilder
Source§fn default() -> QuipConfigurationBuilder
fn default() -> QuipConfigurationBuilder
Source§impl PartialEq for QuipConfigurationBuilder
impl PartialEq for QuipConfigurationBuilder
impl StructuralPartialEq for QuipConfigurationBuilder
Auto Trait Implementations§
impl Freeze for QuipConfigurationBuilder
impl RefUnwindSafe for QuipConfigurationBuilder
impl Send for QuipConfigurationBuilder
impl Sync for QuipConfigurationBuilder
impl Unpin for QuipConfigurationBuilder
impl UnwindSafe for QuipConfigurationBuilder
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);