software.amazon.awssdk.services.kendra.model

Interface SortingConfiguration.Builder

All Superinterfaces:

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

Enclosing class:

SortingConfiguration

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

Method Summary

Modifier and Type	Method and Description
SortingConfiguration.Builder	documentAttributeKey(String documentAttributeKey) The name of the document attribute used to sort the response.
SortingConfiguration.Builder	sortOrder(SortOrder sortOrder) The order that the results should be returned in.
SortingConfiguration.Builder	sortOrder(String sortOrder) The order that the results should be returned in.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

documentAttributeKey

SortingConfiguration.Builder documentAttributeKey(String documentAttributeKey)

The name of the document attribute used to sort the response. You can use any field 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 name of the document attribute used to sort the response. You can use any field 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.

sortOrder

SortingConfiguration.Builder sortOrder(String sortOrder)

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Parameters:

sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

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

See Also:

SortOrder, SortOrder

sortOrder

SortingConfiguration.Builder sortOrder(SortOrder sortOrder)

The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Parameters:

sortOrder - The order that the results should be returned in. In case of ties, the relevance assigned to the result by Amazon Kendra is used as the tie-breaker.

Returns:

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

See Also:

SortOrder, SortOrder