#[non_exhaustive]pub struct MongoDbAtlasConfigurationBuilder { /* private fields */ }
Expand description
A builder for MongoDbAtlasConfiguration
.
Implementations§
Source§impl MongoDbAtlasConfigurationBuilder
impl MongoDbAtlasConfigurationBuilder
Sourcepub fn endpoint(self, input: impl Into<String>) -> Self
pub fn endpoint(self, input: impl Into<String>) -> Self
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
This field is required.Sourcepub fn set_endpoint(self, input: Option<String>) -> Self
pub fn set_endpoint(self, input: Option<String>) -> Self
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
Sourcepub fn get_endpoint(&self) -> &Option<String>
pub fn get_endpoint(&self) -> &Option<String>
The endpoint URL of your MongoDB Atlas cluster for your knowledge base.
Sourcepub fn database_name(self, input: impl Into<String>) -> Self
pub fn database_name(self, input: impl Into<String>) -> Self
The database name in your MongoDB Atlas cluster for your knowledge base.
This field is required.Sourcepub fn set_database_name(self, input: Option<String>) -> Self
pub fn set_database_name(self, input: Option<String>) -> Self
The database name in your MongoDB Atlas cluster for your knowledge base.
Sourcepub fn get_database_name(&self) -> &Option<String>
pub fn get_database_name(&self) -> &Option<String>
The database name in your MongoDB Atlas cluster for your knowledge base.
Sourcepub fn collection_name(self, input: impl Into<String>) -> Self
pub fn collection_name(self, input: impl Into<String>) -> Self
The collection name of the knowledge base in MongoDB Atlas.
This field is required.Sourcepub fn set_collection_name(self, input: Option<String>) -> Self
pub fn set_collection_name(self, input: Option<String>) -> Self
The collection name of the knowledge base in MongoDB Atlas.
Sourcepub fn get_collection_name(&self) -> &Option<String>
pub fn get_collection_name(&self) -> &Option<String>
The collection name of the knowledge base in MongoDB Atlas.
Sourcepub fn vector_index_name(self, input: impl Into<String>) -> Self
pub fn vector_index_name(self, input: impl Into<String>) -> Self
The name of the MongoDB Atlas vector search index.
This field is required.Sourcepub fn set_vector_index_name(self, input: Option<String>) -> Self
pub fn set_vector_index_name(self, input: Option<String>) -> Self
The name of the MongoDB Atlas vector search index.
Sourcepub fn get_vector_index_name(&self) -> &Option<String>
pub fn get_vector_index_name(&self) -> &Option<String>
The name of the MongoDB Atlas vector search index.
Sourcepub fn credentials_secret_arn(self, input: impl Into<String>) -> Self
pub fn credentials_secret_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
This field is required.Sourcepub fn set_credentials_secret_arn(self, input: Option<String>) -> Self
pub fn set_credentials_secret_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
Sourcepub fn get_credentials_secret_arn(&self) -> &Option<String>
pub fn get_credentials_secret_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the secret that you created in Secrets Manager that contains user credentials for your MongoDB Atlas cluster.
Sourcepub fn field_mapping(self, input: MongoDbAtlasFieldMapping) -> Self
pub fn field_mapping(self, input: MongoDbAtlasFieldMapping) -> Self
Contains the names of the fields to which to map information about the vector store.
This field is required.Sourcepub fn set_field_mapping(self, input: Option<MongoDbAtlasFieldMapping>) -> Self
pub fn set_field_mapping(self, input: Option<MongoDbAtlasFieldMapping>) -> Self
Contains the names of the fields to which to map information about the vector store.
Sourcepub fn get_field_mapping(&self) -> &Option<MongoDbAtlasFieldMapping>
pub fn get_field_mapping(&self) -> &Option<MongoDbAtlasFieldMapping>
Contains the names of the fields to which to map information about the vector store.
Sourcepub fn endpoint_service_name(self, input: impl Into<String>) -> Self
pub fn endpoint_service_name(self, input: impl Into<String>) -> Self
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Sourcepub fn set_endpoint_service_name(self, input: Option<String>) -> Self
pub fn set_endpoint_service_name(self, input: Option<String>) -> Self
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Sourcepub fn get_endpoint_service_name(&self) -> &Option<String>
pub fn get_endpoint_service_name(&self) -> &Option<String>
The name of the VPC endpoint service in your account that is connected to your MongoDB Atlas cluster.
Sourcepub fn text_index_name(self, input: impl Into<String>) -> Self
pub fn text_index_name(self, input: impl Into<String>) -> Self
The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
Sourcepub fn set_text_index_name(self, input: Option<String>) -> Self
pub fn set_text_index_name(self, input: Option<String>) -> Self
The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
Sourcepub fn get_text_index_name(&self) -> &Option<String>
pub fn get_text_index_name(&self) -> &Option<String>
The name of the text search index in the MongoDB collection. This is required for using the hybrid search feature.
Sourcepub fn build(self) -> Result<MongoDbAtlasConfiguration, BuildError>
pub fn build(self) -> Result<MongoDbAtlasConfiguration, BuildError>
Consumes the builder and constructs a MongoDbAtlasConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for MongoDbAtlasConfigurationBuilder
impl Clone for MongoDbAtlasConfigurationBuilder
Source§fn clone(&self) -> MongoDbAtlasConfigurationBuilder
fn clone(&self) -> MongoDbAtlasConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for MongoDbAtlasConfigurationBuilder
impl Default for MongoDbAtlasConfigurationBuilder
Source§fn default() -> MongoDbAtlasConfigurationBuilder
fn default() -> MongoDbAtlasConfigurationBuilder
Source§impl PartialEq for MongoDbAtlasConfigurationBuilder
impl PartialEq for MongoDbAtlasConfigurationBuilder
Source§fn eq(&self, other: &MongoDbAtlasConfigurationBuilder) -> bool
fn eq(&self, other: &MongoDbAtlasConfigurationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for MongoDbAtlasConfigurationBuilder
Auto Trait Implementations§
impl Freeze for MongoDbAtlasConfigurationBuilder
impl RefUnwindSafe for MongoDbAtlasConfigurationBuilder
impl Send for MongoDbAtlasConfigurationBuilder
impl Sync for MongoDbAtlasConfigurationBuilder
impl Unpin for MongoDbAtlasConfigurationBuilder
impl UnwindSafe for MongoDbAtlasConfigurationBuilder
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);