Package software.amazon.awssdk.services.kendra.model

Interface CollapseConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CollapseConfiguration.Builder,CollapseConfiguration>, SdkBuilder<CollapseConfiguration.Builder,CollapseConfiguration>, SdkPojo

Enclosing class:

CollapseConfiguration

public static interface CollapseConfiguration.Builder
extends SdkPojo, CopyableBuilder<CollapseConfiguration.Builder,CollapseConfiguration>

Method Summary

Modifier and Type	Method	Description
CollapseConfiguration.Builder	documentAttributeKey(String documentAttributeKey)	The document attribute used to group search results.
CollapseConfiguration.Builder	expand(Boolean expand)	Specifies whether to expand the collapsed results.
default CollapseConfiguration.Builder	expandConfiguration(Consumer<ExpandConfiguration.Builder> expandConfiguration)	Provides configuration information to customize expansion options for a collapsed group.
CollapseConfiguration.Builder	expandConfiguration(ExpandConfiguration expandConfiguration)	Provides configuration information to customize expansion options for a collapsed group.
CollapseConfiguration.Builder	missingAttributeKeyStrategy(String missingAttributeKeyStrategy)	Specifies the behavior for documents without a value for the collapse attribute.
CollapseConfiguration.Builder	missingAttributeKeyStrategy(MissingAttributeKeyStrategy missingAttributeKeyStrategy)	Specifies the behavior for documents without a value for the collapse attribute.
CollapseConfiguration.Builder	sortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)	A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
CollapseConfiguration.Builder	sortingConfigurations(Consumer<SortingConfiguration.Builder>... sortingConfigurations)	A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.
CollapseConfiguration.Builder	sortingConfigurations(SortingConfiguration... sortingConfigurations)	A prioritized list of document attributes/fields that determine the primary document among those in a collapsed group.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

documentAttributeKey

CollapseConfiguration.Builder documentAttributeKey(String documentAttributeKey)

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".

Parameters:

documentAttributeKey - 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".

Returns:

Returns a reference to this object so that method calls can be chained together.

sortingConfigurations

CollapseConfiguration.Builder sortingConfigurations(Collection<SortingConfiguration> sortingConfigurations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortingConfigurations

CollapseConfiguration.Builder sortingConfigurations(SortingConfiguration... sortingConfigurations)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sortingConfigurations

CollapseConfiguration.Builder sortingConfigurations(Consumer<SortingConfiguration.Builder>... sortingConfigurations)

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

This is a convenience method that creates an instance of the SortingConfiguration.Builder avoiding the need to create one manually via SortingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #sortingConfigurations(List).

Parameters:

sortingConfigurations - a consumer that will call methods on SortingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#sortingConfigurations(java.util.Collection)

missingAttributeKeyStrategy

CollapseConfiguration.Builder missingAttributeKeyStrategy(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MissingAttributeKeyStrategy, MissingAttributeKeyStrategy

missingAttributeKeyStrategy

CollapseConfiguration.Builder missingAttributeKeyStrategy(MissingAttributeKeyStrategy 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MissingAttributeKeyStrategy, MissingAttributeKeyStrategy

expand

CollapseConfiguration.Builder expand(Boolean expand)

Specifies whether to expand the collapsed results.

Parameters:

expand - Specifies whether to expand the collapsed results.

Returns:

Returns a reference to this object so that method calls can be chained together.

expandConfiguration

CollapseConfiguration.Builder expandConfiguration(ExpandConfiguration expandConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

expandConfiguration

default CollapseConfiguration.Builder expandConfiguration(Consumer<ExpandConfiguration.Builder> expandConfiguration)

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

This is a convenience method that creates an instance of the ExpandConfiguration.Builder avoiding the need to create one manually via ExpandConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to expandConfiguration(ExpandConfiguration).

Parameters:

expandConfiguration - a consumer that will call methods on ExpandConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

expandConfiguration(ExpandConfiguration)