Struct Search 

#[non_exhaustive]
pub struct Search {
    pub facetable: bool,
    pub searchable: bool,
    pub displayable: bool,
    pub sortable: bool,
}

Provides information about how a custom index field is used during a search.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

facetable: bool

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

searchable: bool

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

displayable: bool

Determines whether the field is returned in the query response. The default is true.

sortable: bool

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Implementations

impl Search

pub fn facetable(&self) -> bool

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

pub fn searchable(&self) -> bool

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

pub fn displayable(&self) -> bool

Determines whether the field is returned in the query response. The default is true.

pub fn sortable(&self) -> bool

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

impl Search

pub fn builder() -> SearchBuilder

Creates a new builder-style object to manufacture Search.

Trait Implementations

impl Clone for Search

fn clone(&self) -> Search

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Search

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

Formats the value using the given formatter.

impl PartialEq for Search

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Search