software.amazon.awssdk.services.kendra.model

Interface Search.Builder

All Superinterfaces:

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

Enclosing class:

Search

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

Method Summary

Modifier and Type	Method and Description
Search.Builder	displayable(Boolean displayable) Determines whether the field is returned in the query response.
Search.Builder	facetable(Boolean facetable) Indicates that the field can be used to create search facets, a count of results for each value in the field.
Search.Builder	searchable(Boolean searchable) Determines whether the field is used in the search.
Search.Builder	sortable(Boolean sortable) Determines whether the field can be used to sort the results of a query.

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

facetable

Search.Builder facetable(Boolean facetable)

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 .

Parameters:

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

Returns:

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

searchable

Search.Builder searchable(Boolean searchable)

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.

Parameters:

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

Returns:

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

displayable

Search.Builder displayable(Boolean displayable)

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

Parameters:

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

Returns:

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

sortable

Search.Builder sortable(Boolean sortable)

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.

Parameters:

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

Returns:

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