#[non_exhaustive]pub struct QueryOutputBuilder { /* private fields */ }
Expand description
A builder for QueryOutput
.
Implementations§
Source§impl QueryOutputBuilder
impl QueryOutputBuilder
Sourcepub fn query_id(self, input: impl Into<String>) -> Self
pub fn query_id(self, input: impl Into<String>) -> Self
The identifier for the search. You also use QueryId
to identify the search when using the SubmitFeedback API.
Sourcepub fn set_query_id(self, input: Option<String>) -> Self
pub fn set_query_id(self, input: Option<String>) -> Self
The identifier for the search. You also use QueryId
to identify the search when using the SubmitFeedback API.
Sourcepub fn get_query_id(&self) -> &Option<String>
pub fn get_query_id(&self) -> &Option<String>
The identifier for the search. You also use QueryId
to identify the search when using the SubmitFeedback API.
Sourcepub fn result_items(self, input: QueryResultItem) -> Self
pub fn result_items(self, input: QueryResultItem) -> Self
Appends an item to result_items
.
To override the contents of this collection use set_result_items
.
The results of the search.
Sourcepub fn set_result_items(self, input: Option<Vec<QueryResultItem>>) -> Self
pub fn set_result_items(self, input: Option<Vec<QueryResultItem>>) -> Self
The results of the search.
Sourcepub fn get_result_items(&self) -> &Option<Vec<QueryResultItem>>
pub fn get_result_items(&self) -> &Option<Vec<QueryResultItem>>
The results of the search.
Sourcepub fn facet_results(self, input: FacetResult) -> Self
pub fn facet_results(self, input: FacetResult) -> Self
Appends an item to facet_results
.
To override the contents of this collection use set_facet_results
.
Contains the facet results. A FacetResult
contains the counts for each field/attribute key that was specified in the Facets
input parameter.
Sourcepub fn set_facet_results(self, input: Option<Vec<FacetResult>>) -> Self
pub fn set_facet_results(self, input: Option<Vec<FacetResult>>) -> Self
Contains the facet results. A FacetResult
contains the counts for each field/attribute key that was specified in the Facets
input parameter.
Sourcepub fn get_facet_results(&self) -> &Option<Vec<FacetResult>>
pub fn get_facet_results(&self) -> &Option<Vec<FacetResult>>
Contains the facet results. A FacetResult
contains the counts for each field/attribute key that was specified in the Facets
input parameter.
Sourcepub fn total_number_of_results(self, input: i32) -> Self
pub fn total_number_of_results(self, input: i32) -> Self
The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
Sourcepub fn set_total_number_of_results(self, input: Option<i32>) -> Self
pub fn set_total_number_of_results(self, input: Option<i32>) -> Self
The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
Sourcepub fn get_total_number_of_results(&self) -> &Option<i32>
pub fn get_total_number_of_results(&self) -> &Option<i32>
The total number of items found by the search. However, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.
Sourcepub fn warnings(self, input: Warning) -> Self
pub fn warnings(self, input: Warning) -> Self
Appends an item to warnings
.
To override the contents of this collection use set_warnings
.
A list of warning codes and their messages on problems with your query.
Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.
Sourcepub fn set_warnings(self, input: Option<Vec<Warning>>) -> Self
pub fn set_warnings(self, input: Option<Vec<Warning>>) -> Self
A list of warning codes and their messages on problems with your query.
Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.
Sourcepub fn get_warnings(&self) -> &Option<Vec<Warning>>
pub fn get_warnings(&self) -> &Option<Vec<Warning>>
A list of warning codes and their messages on problems with your query.
Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.
Sourcepub fn spell_corrected_queries(self, input: SpellCorrectedQuery) -> Self
pub fn spell_corrected_queries(self, input: SpellCorrectedQuery) -> Self
Appends an item to spell_corrected_queries
.
To override the contents of this collection use set_spell_corrected_queries
.
A list of information related to suggested spell corrections for a query.
Sourcepub fn set_spell_corrected_queries(
self,
input: Option<Vec<SpellCorrectedQuery>>,
) -> Self
pub fn set_spell_corrected_queries( self, input: Option<Vec<SpellCorrectedQuery>>, ) -> Self
A list of information related to suggested spell corrections for a query.
Sourcepub fn get_spell_corrected_queries(&self) -> &Option<Vec<SpellCorrectedQuery>>
pub fn get_spell_corrected_queries(&self) -> &Option<Vec<SpellCorrectedQuery>>
A list of information related to suggested spell corrections for a query.
Sourcepub fn featured_results_items(self, input: FeaturedResultsItem) -> Self
pub fn featured_results_items(self, input: FeaturedResultsItem) -> Self
Appends an item to featured_results_items
.
To override the contents of this collection use set_featured_results_items
.
The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
Sourcepub fn set_featured_results_items(
self,
input: Option<Vec<FeaturedResultsItem>>,
) -> Self
pub fn set_featured_results_items( self, input: Option<Vec<FeaturedResultsItem>>, ) -> Self
The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
Sourcepub fn get_featured_results_items(&self) -> &Option<Vec<FeaturedResultsItem>>
pub fn get_featured_results_items(&self) -> &Option<Vec<FeaturedResultsItem>>
The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.
Sourcepub fn build(self) -> QueryOutput
pub fn build(self) -> QueryOutput
Consumes the builder and constructs a QueryOutput
.
Trait Implementations§
Source§impl Clone for QueryOutputBuilder
impl Clone for QueryOutputBuilder
Source§fn clone(&self) -> QueryOutputBuilder
fn clone(&self) -> QueryOutputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for QueryOutputBuilder
impl Debug for QueryOutputBuilder
Source§impl Default for QueryOutputBuilder
impl Default for QueryOutputBuilder
Source§fn default() -> QueryOutputBuilder
fn default() -> QueryOutputBuilder
Source§impl PartialEq for QueryOutputBuilder
impl PartialEq for QueryOutputBuilder
impl StructuralPartialEq for QueryOutputBuilder
Auto Trait Implementations§
impl Freeze for QueryOutputBuilder
impl RefUnwindSafe for QueryOutputBuilder
impl Send for QueryOutputBuilder
impl Sync for QueryOutputBuilder
impl Unpin for QueryOutputBuilder
impl UnwindSafe for QueryOutputBuilder
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);