#[non_exhaustive]pub struct RetrievalResultLocationBuilder { /* private fields */ }
Expand description
A builder for RetrievalResultLocation
.
Implementations§
Source§impl RetrievalResultLocationBuilder
impl RetrievalResultLocationBuilder
Sourcepub fn type(self, input: RetrievalResultLocationType) -> Self
pub fn type(self, input: RetrievalResultLocationType) -> Self
The type of data source location.
This field is required.Sourcepub fn set_type(self, input: Option<RetrievalResultLocationType>) -> Self
pub fn set_type(self, input: Option<RetrievalResultLocationType>) -> Self
The type of data source location.
Sourcepub fn get_type(&self) -> &Option<RetrievalResultLocationType>
pub fn get_type(&self) -> &Option<RetrievalResultLocationType>
The type of data source location.
Sourcepub fn s3_location(self, input: RetrievalResultS3Location) -> Self
pub fn s3_location(self, input: RetrievalResultS3Location) -> Self
The S3 data source location.
Sourcepub fn set_s3_location(self, input: Option<RetrievalResultS3Location>) -> Self
pub fn set_s3_location(self, input: Option<RetrievalResultS3Location>) -> Self
The S3 data source location.
Sourcepub fn get_s3_location(&self) -> &Option<RetrievalResultS3Location>
pub fn get_s3_location(&self) -> &Option<RetrievalResultS3Location>
The S3 data source location.
Sourcepub fn web_location(self, input: RetrievalResultWebLocation) -> Self
pub fn web_location(self, input: RetrievalResultWebLocation) -> Self
The web URL/URLs data source location.
Sourcepub fn set_web_location(self, input: Option<RetrievalResultWebLocation>) -> Self
pub fn set_web_location(self, input: Option<RetrievalResultWebLocation>) -> Self
The web URL/URLs data source location.
Sourcepub fn get_web_location(&self) -> &Option<RetrievalResultWebLocation>
pub fn get_web_location(&self) -> &Option<RetrievalResultWebLocation>
The web URL/URLs data source location.
Sourcepub fn confluence_location(
self,
input: RetrievalResultConfluenceLocation,
) -> Self
pub fn confluence_location( self, input: RetrievalResultConfluenceLocation, ) -> Self
The Confluence data source location.
Sourcepub fn set_confluence_location(
self,
input: Option<RetrievalResultConfluenceLocation>,
) -> Self
pub fn set_confluence_location( self, input: Option<RetrievalResultConfluenceLocation>, ) -> Self
The Confluence data source location.
Sourcepub fn get_confluence_location(
&self,
) -> &Option<RetrievalResultConfluenceLocation>
pub fn get_confluence_location( &self, ) -> &Option<RetrievalResultConfluenceLocation>
The Confluence data source location.
Sourcepub fn salesforce_location(
self,
input: RetrievalResultSalesforceLocation,
) -> Self
pub fn salesforce_location( self, input: RetrievalResultSalesforceLocation, ) -> Self
The Salesforce data source location.
Sourcepub fn set_salesforce_location(
self,
input: Option<RetrievalResultSalesforceLocation>,
) -> Self
pub fn set_salesforce_location( self, input: Option<RetrievalResultSalesforceLocation>, ) -> Self
The Salesforce data source location.
Sourcepub fn get_salesforce_location(
&self,
) -> &Option<RetrievalResultSalesforceLocation>
pub fn get_salesforce_location( &self, ) -> &Option<RetrievalResultSalesforceLocation>
The Salesforce data source location.
The SharePoint data source location.
The SharePoint data source location.
The SharePoint data source location.
Sourcepub fn custom_document_location(
self,
input: RetrievalResultCustomDocumentLocation,
) -> Self
pub fn custom_document_location( self, input: RetrievalResultCustomDocumentLocation, ) -> Self
Specifies the location of a document in a custom data source.
Sourcepub fn set_custom_document_location(
self,
input: Option<RetrievalResultCustomDocumentLocation>,
) -> Self
pub fn set_custom_document_location( self, input: Option<RetrievalResultCustomDocumentLocation>, ) -> Self
Specifies the location of a document in a custom data source.
Sourcepub fn get_custom_document_location(
&self,
) -> &Option<RetrievalResultCustomDocumentLocation>
pub fn get_custom_document_location( &self, ) -> &Option<RetrievalResultCustomDocumentLocation>
Specifies the location of a document in a custom data source.
Sourcepub fn kendra_document_location(
self,
input: RetrievalResultKendraDocumentLocation,
) -> Self
pub fn kendra_document_location( self, input: RetrievalResultKendraDocumentLocation, ) -> Self
The location of a document in Amazon Kendra.
Sourcepub fn set_kendra_document_location(
self,
input: Option<RetrievalResultKendraDocumentLocation>,
) -> Self
pub fn set_kendra_document_location( self, input: Option<RetrievalResultKendraDocumentLocation>, ) -> Self
The location of a document in Amazon Kendra.
Sourcepub fn get_kendra_document_location(
&self,
) -> &Option<RetrievalResultKendraDocumentLocation>
pub fn get_kendra_document_location( &self, ) -> &Option<RetrievalResultKendraDocumentLocation>
The location of a document in Amazon Kendra.
Sourcepub fn sql_location(self, input: RetrievalResultSqlLocation) -> Self
pub fn sql_location(self, input: RetrievalResultSqlLocation) -> Self
Specifies information about the SQL query used to retrieve the result.
Sourcepub fn set_sql_location(self, input: Option<RetrievalResultSqlLocation>) -> Self
pub fn set_sql_location(self, input: Option<RetrievalResultSqlLocation>) -> Self
Specifies information about the SQL query used to retrieve the result.
Sourcepub fn get_sql_location(&self) -> &Option<RetrievalResultSqlLocation>
pub fn get_sql_location(&self) -> &Option<RetrievalResultSqlLocation>
Specifies information about the SQL query used to retrieve the result.
Sourcepub fn build(self) -> Result<RetrievalResultLocation, BuildError>
pub fn build(self) -> Result<RetrievalResultLocation, BuildError>
Consumes the builder and constructs a RetrievalResultLocation
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for RetrievalResultLocationBuilder
impl Clone for RetrievalResultLocationBuilder
Source§fn clone(&self) -> RetrievalResultLocationBuilder
fn clone(&self) -> RetrievalResultLocationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for RetrievalResultLocationBuilder
impl Default for RetrievalResultLocationBuilder
Source§fn default() -> RetrievalResultLocationBuilder
fn default() -> RetrievalResultLocationBuilder
Source§impl PartialEq for RetrievalResultLocationBuilder
impl PartialEq for RetrievalResultLocationBuilder
Source§fn eq(&self, other: &RetrievalResultLocationBuilder) -> bool
fn eq(&self, other: &RetrievalResultLocationBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for RetrievalResultLocationBuilder
Auto Trait Implementations§
impl Freeze for RetrievalResultLocationBuilder
impl RefUnwindSafe for RetrievalResultLocationBuilder
impl Send for RetrievalResultLocationBuilder
impl Sync for RetrievalResultLocationBuilder
impl Unpin for RetrievalResultLocationBuilder
impl UnwindSafe for RetrievalResultLocationBuilder
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);