#[non_exhaustive]pub struct KnowledgeBaseBuilder { /* private fields */ }
Expand description
A builder for KnowledgeBase
.
Implementations§
Source§impl KnowledgeBaseBuilder
impl KnowledgeBaseBuilder
Sourcepub fn knowledge_base_id(self, input: impl Into<String>) -> Self
pub fn knowledge_base_id(self, input: impl Into<String>) -> Self
The unique identifier of the knowledge base.
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 unique identifier of the knowledge base.
Sourcepub fn get_knowledge_base_id(&self) -> &Option<String>
pub fn get_knowledge_base_id(&self) -> &Option<String>
The unique identifier 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_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 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.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
Sourcepub fn knowledge_base_configuration(
self,
input: KnowledgeBaseConfiguration,
) -> Self
pub fn knowledge_base_configuration( self, input: KnowledgeBaseConfiguration, ) -> Self
Contains details about the embeddings configuration of the knowledge base.
This field is required.Sourcepub fn set_knowledge_base_configuration(
self,
input: Option<KnowledgeBaseConfiguration>,
) -> Self
pub fn set_knowledge_base_configuration( self, input: Option<KnowledgeBaseConfiguration>, ) -> Self
Contains details about the embeddings configuration of the knowledge base.
Sourcepub fn get_knowledge_base_configuration(
&self,
) -> &Option<KnowledgeBaseConfiguration>
pub fn get_knowledge_base_configuration( &self, ) -> &Option<KnowledgeBaseConfiguration>
Contains details about the embeddings configuration of the knowledge base.
Sourcepub fn storage_configuration(self, input: StorageConfiguration) -> Self
pub fn storage_configuration(self, input: StorageConfiguration) -> Self
Contains details about the storage configuration of the knowledge base.
Sourcepub fn set_storage_configuration(
self,
input: Option<StorageConfiguration>,
) -> Self
pub fn set_storage_configuration( self, input: Option<StorageConfiguration>, ) -> Self
Contains details about the storage configuration of the knowledge base.
Sourcepub fn get_storage_configuration(&self) -> &Option<StorageConfiguration>
pub fn get_storage_configuration(&self) -> &Option<StorageConfiguration>
Contains details about the storage configuration of the knowledge base.
Sourcepub fn status(self, input: KnowledgeBaseStatus) -> Self
pub fn status(self, input: KnowledgeBaseStatus) -> Self
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
Sourcepub fn set_status(self, input: Option<KnowledgeBaseStatus>) -> Self
pub fn set_status(self, input: Option<KnowledgeBaseStatus>) -> Self
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
Sourcepub fn get_status(&self) -> &Option<KnowledgeBaseStatus>
pub fn get_status(&self) -> &Option<KnowledgeBaseStatus>
The status of the knowledge base. The following statuses are possible:
-
CREATING – The knowledge base is being created.
-
ACTIVE – The knowledge base is ready to be queried.
-
DELETING – The knowledge base is being deleted.
-
UPDATING – The knowledge base is being updated.
-
FAILED – The knowledge base API operation failed.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The time the knowledge base was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The time the knowledge base was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The time the knowledge base was created.
Sourcepub fn updated_at(self, input: DateTime) -> Self
pub fn updated_at(self, input: DateTime) -> Self
The time the knowledge base was last updated.
This field is required.Sourcepub fn set_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_updated_at(self, input: Option<DateTime>) -> Self
The time the knowledge base was last updated.
Sourcepub fn get_updated_at(&self) -> &Option<DateTime>
pub fn get_updated_at(&self) -> &Option<DateTime>
The time the knowledge base was last updated.
Sourcepub fn failure_reasons(self, input: impl Into<String>) -> Self
pub fn failure_reasons(self, input: impl Into<String>) -> Self
Appends an item to failure_reasons
.
To override the contents of this collection use set_failure_reasons
.
A list of reasons that the API operation on the knowledge base failed.
Sourcepub fn set_failure_reasons(self, input: Option<Vec<String>>) -> Self
pub fn set_failure_reasons(self, input: Option<Vec<String>>) -> Self
A list of reasons that the API operation on the knowledge base failed.
Sourcepub fn get_failure_reasons(&self) -> &Option<Vec<String>>
pub fn get_failure_reasons(&self) -> &Option<Vec<String>>
A list of reasons that the API operation on the knowledge base failed.
Sourcepub fn build(self) -> Result<KnowledgeBase, BuildError>
pub fn build(self) -> Result<KnowledgeBase, BuildError>
Consumes the builder and constructs a KnowledgeBase
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for KnowledgeBaseBuilder
impl Clone for KnowledgeBaseBuilder
Source§fn clone(&self) -> KnowledgeBaseBuilder
fn clone(&self) -> KnowledgeBaseBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for KnowledgeBaseBuilder
impl Debug for KnowledgeBaseBuilder
Source§impl Default for KnowledgeBaseBuilder
impl Default for KnowledgeBaseBuilder
Source§fn default() -> KnowledgeBaseBuilder
fn default() -> KnowledgeBaseBuilder
Source§impl PartialEq for KnowledgeBaseBuilder
impl PartialEq for KnowledgeBaseBuilder
impl StructuralPartialEq for KnowledgeBaseBuilder
Auto Trait Implementations§
impl Freeze for KnowledgeBaseBuilder
impl RefUnwindSafe for KnowledgeBaseBuilder
impl Send for KnowledgeBaseBuilder
impl Sync for KnowledgeBaseBuilder
impl Unpin for KnowledgeBaseBuilder
impl UnwindSafe for KnowledgeBaseBuilder
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);