#[non_exhaustive]pub struct KnowledgeBaseSummaryBuilder { /* private fields */ }
Expand description
A builder for KnowledgeBaseSummary
.
Implementations§
Source§impl KnowledgeBaseSummaryBuilder
impl KnowledgeBaseSummaryBuilder
Sourcepub fn knowledge_base_id(self, input: impl Into<String>) -> Self
pub fn knowledge_base_id(self, input: impl Into<String>) -> Self
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
This field is required.Sourcepub fn set_knowledge_base_id(self, input: Option<String>) -> Self
pub fn set_knowledge_base_id(self, input: Option<String>) -> Self
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
Sourcepub fn get_knowledge_base_id(&self) -> &Option<String>
pub fn get_knowledge_base_id(&self) -> &Option<String>
The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
Sourcepub fn knowledge_base_arn(self, input: impl Into<String>) -> Self
pub fn knowledge_base_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the knowledge base.
This field is required.Sourcepub fn set_knowledge_base_arn(self, input: Option<String>) -> Self
pub fn set_knowledge_base_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the knowledge base.
Sourcepub fn get_knowledge_base_arn(&self) -> &Option<String>
pub fn get_knowledge_base_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the knowledge base.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the knowledge base.
This field is required.Sourcepub fn knowledge_base_type(self, input: KnowledgeBaseType) -> Self
pub fn knowledge_base_type(self, input: KnowledgeBaseType) -> Self
The type of knowledge base.
This field is required.Sourcepub fn set_knowledge_base_type(self, input: Option<KnowledgeBaseType>) -> Self
pub fn set_knowledge_base_type(self, input: Option<KnowledgeBaseType>) -> Self
The type of knowledge base.
Sourcepub fn get_knowledge_base_type(&self) -> &Option<KnowledgeBaseType>
pub fn get_knowledge_base_type(&self) -> &Option<KnowledgeBaseType>
The type of knowledge base.
Sourcepub fn status(self, input: KnowledgeBaseStatus) -> Self
pub fn status(self, input: KnowledgeBaseStatus) -> Self
The status of the knowledge base summary.
This field is required.Sourcepub fn set_status(self, input: Option<KnowledgeBaseStatus>) -> Self
pub fn set_status(self, input: Option<KnowledgeBaseStatus>) -> Self
The status of the knowledge base summary.
Sourcepub fn get_status(&self) -> &Option<KnowledgeBaseStatus>
pub fn get_status(&self) -> &Option<KnowledgeBaseStatus>
The status of the knowledge base summary.
Sourcepub fn source_configuration(self, input: SourceConfiguration) -> Self
pub fn source_configuration(self, input: SourceConfiguration) -> Self
Configuration information about the external data source.
Sourcepub fn set_source_configuration(
self,
input: Option<SourceConfiguration>,
) -> Self
pub fn set_source_configuration( self, input: Option<SourceConfiguration>, ) -> Self
Configuration information about the external data source.
Sourcepub fn get_source_configuration(&self) -> &Option<SourceConfiguration>
pub fn get_source_configuration(&self) -> &Option<SourceConfiguration>
Configuration information about the external data source.
Sourcepub fn rendering_configuration(self, input: RenderingConfiguration) -> Self
pub fn rendering_configuration(self, input: RenderingConfiguration) -> Self
Information about how to render the content.
Sourcepub fn set_rendering_configuration(
self,
input: Option<RenderingConfiguration>,
) -> Self
pub fn set_rendering_configuration( self, input: Option<RenderingConfiguration>, ) -> Self
Information about how to render the content.
Sourcepub fn get_rendering_configuration(&self) -> &Option<RenderingConfiguration>
pub fn get_rendering_configuration(&self) -> &Option<RenderingConfiguration>
Information about how to render the content.
Sourcepub fn server_side_encryption_configuration(
self,
input: ServerSideEncryptionConfiguration,
) -> Self
pub fn server_side_encryption_configuration( self, input: ServerSideEncryptionConfiguration, ) -> Self
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant
, kms:DescribeKey
, kms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
Sourcepub fn set_server_side_encryption_configuration(
self,
input: Option<ServerSideEncryptionConfiguration>,
) -> Self
pub fn set_server_side_encryption_configuration( self, input: Option<ServerSideEncryptionConfiguration>, ) -> Self
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant
, kms:DescribeKey
, kms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
Sourcepub fn get_server_side_encryption_configuration(
&self,
) -> &Option<ServerSideEncryptionConfiguration>
pub fn get_server_side_encryption_configuration( &self, ) -> &Option<ServerSideEncryptionConfiguration>
The configuration information for the customer managed key used for encryption.
This KMS key must have a policy that allows kms:CreateGrant
, kms:DescribeKey
, kms:Decrypt/kms:GenerateDataKey
permissions to the IAM identity using the key to invoke Wisdom.
For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
The description of the knowledge base.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
The description of the knowledge base.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
The description of the knowledge base.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
The tags used to organize, track, or control access for this resource.
Sourcepub fn build(self) -> Result<KnowledgeBaseSummary, BuildError>
pub fn build(self) -> Result<KnowledgeBaseSummary, BuildError>
Consumes the builder and constructs a KnowledgeBaseSummary
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for KnowledgeBaseSummaryBuilder
impl Clone for KnowledgeBaseSummaryBuilder
Source§fn clone(&self) -> KnowledgeBaseSummaryBuilder
fn clone(&self) -> KnowledgeBaseSummaryBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for KnowledgeBaseSummaryBuilder
impl Debug for KnowledgeBaseSummaryBuilder
Source§impl Default for KnowledgeBaseSummaryBuilder
impl Default for KnowledgeBaseSummaryBuilder
Source§fn default() -> KnowledgeBaseSummaryBuilder
fn default() -> KnowledgeBaseSummaryBuilder
impl StructuralPartialEq for KnowledgeBaseSummaryBuilder
Auto Trait Implementations§
impl Freeze for KnowledgeBaseSummaryBuilder
impl RefUnwindSafe for KnowledgeBaseSummaryBuilder
impl Send for KnowledgeBaseSummaryBuilder
impl Sync for KnowledgeBaseSummaryBuilder
impl Unpin for KnowledgeBaseSummaryBuilder
impl UnwindSafe for KnowledgeBaseSummaryBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);