Struct aws_sdk_kendra::operation::query::builders::QueryOutputBuilder

#[non_exhaustive]
pub struct QueryOutputBuilder { /* private fields */ }

A builder for QueryOutput.

Implementations

impl QueryOutputBuilder

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.

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.

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.

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.

pub fn set_result_items(self, input: Option<Vec<QueryResultItem>>) -> Self

The results of the search.

pub fn get_result_items(&self) -> &Option<Vec<QueryResultItem>>

The results of the search.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

pub fn set_spell_corrected_queries( self, input: Option<Vec<SpellCorrectedQuery>> ) -> Self

A list of information related to suggested spell corrections for a query.

pub fn get_spell_corrected_queries(&self) -> &Option<Vec<SpellCorrectedQuery>>

A list of information related to suggested spell corrections for a query.

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.

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.

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.

pub fn build(self) -> QueryOutput

Consumes the builder and constructs a QueryOutput.

Trait Implementations

impl Clone for QueryOutputBuilder

fn clone(&self) -> QueryOutputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryOutputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryOutputBuilder

fn default() -> QueryOutputBuilder

Returns the “default value” for a type.

impl PartialEq for QueryOutputBuilder

fn eq(&self, other: &QueryOutputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for QueryOutputBuilder