Struct CollapseConfiguration 

#[non_exhaustive]
pub struct CollapseConfiguration {
    pub document_attribute_key: String,
    pub sorting_configurations: Option<Vec<SortingConfiguration>>,
    pub missing_attribute_key_strategy: Option<MissingAttributeKeyStrategy>,
    pub expand: bool,
    pub expand_configuration: Option<ExpandConfiguration>,
}

Specifies how to group results by document attribute value, and how to display them collapsed/expanded under a designated primary document for each group.

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.

document_attribute_key: String

The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

sorting_configurations: Option<Vec<SortingConfiguration>>

A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

missing_attribute_key_strategy: Option<MissingAttributeKeyStrategy>

Specifies the behavior for documents without a value for the collapse attribute.

Amazon Kendra offers three customization options:

• Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

• Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

• Choose to EXPAND each document with a null or missing value into a group of its own.

expand: bool

Specifies whether to expand the collapsed results.

expand_configuration: Option<ExpandConfiguration>

Provides configuration information to customize expansion options for a collapsed group.

Implementations

impl CollapseConfiguration

pub fn document_attribute_key(&self) -> &str

The document attribute used to group search results. You can use any attribute that has the Sortable flag set to true. You can also sort by any of the following built-in attributes:"_category","_created_at", "_last_updated_at", "_version", "_view_count".

pub fn sorting_configurations(&self) -> &[SortingConfiguration]

A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sorting_configurations.is_none().

pub fn missing_attribute_key_strategy( &self, ) -> Option<&MissingAttributeKeyStrategy>

Specifies the behavior for documents without a value for the collapse attribute.

Amazon Kendra offers three customization options:

• Choose to COLLAPSE all documents with null or missing values in one group. This is the default configuration.

• Choose to IGNORE documents with null or missing values. Ignored documents will not appear in query results.

• Choose to EXPAND each document with a null or missing value into a group of its own.

pub fn expand(&self) -> bool

Specifies whether to expand the collapsed results.

pub fn expand_configuration(&self) -> Option<&ExpandConfiguration>

Provides configuration information to customize expansion options for a collapsed group.

impl CollapseConfiguration

pub fn builder() -> CollapseConfigurationBuilder

Creates a new builder-style object to manufacture CollapseConfiguration.

Trait Implementations

impl Clone for CollapseConfiguration

fn clone(&self) -> CollapseConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CollapseConfiguration

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

Formats the value using the given formatter.

impl PartialEq for CollapseConfiguration

fn eq(&self, other: &CollapseConfiguration) -> 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 CollapseConfiguration