software.amazon.awssdk.services.kendra.model

Interface QueryResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<QueryResponse.Builder,QueryResponse>, KendraResponse.Builder, SdkBuilder<QueryResponse.Builder,QueryResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

QueryResponse

public static interface QueryResponse.Builder
extends KendraResponse.Builder, SdkPojo, CopyableBuilder<QueryResponse.Builder,QueryResponse>

Method Summary

Modifier and Type	Method and Description
QueryResponse.Builder	facetResults(Collection<FacetResult> facetResults) Contains the facet results.
QueryResponse.Builder	facetResults(Consumer<FacetResult.Builder>... facetResults) Contains the facet results.
QueryResponse.Builder	facetResults(FacetResult... facetResults) Contains the facet results.
QueryResponse.Builder	queryId(String queryId) The unique identifier for the search.
QueryResponse.Builder	resultItems(Collection<QueryResultItem> resultItems) The results of the search.
QueryResponse.Builder	resultItems(Consumer<QueryResultItem.Builder>... resultItems) The results of the search.
QueryResponse.Builder	resultItems(QueryResultItem... resultItems) The results of the search.
QueryResponse.Builder	totalNumberOfResults(Integer totalNumberOfResults) The total number of items found by the search; however, you can only retrieve up to 100 items.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

queryId

QueryResponse.Builder queryId(String queryId)

The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Parameters:

queryId - The unique identifier for the search. You use QueryId to identify the search when using the feedback API.

Returns:

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

resultItems

QueryResponse.Builder resultItems(Collection<QueryResultItem> resultItems)

The results of the search.

Parameters:

resultItems - The results of the search.

Returns:

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

resultItems

QueryResponse.Builder resultItems(QueryResultItem... resultItems)

The results of the search.

Parameters:

resultItems - The results of the search.

Returns:

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

resultItems

QueryResponse.Builder resultItems(Consumer<QueryResultItem.Builder>... resultItems)

The results of the search.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #resultItems(List).

Parameters:

resultItems - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#resultItems(List)

facetResults

QueryResponse.Builder facetResults(Collection<FacetResult> facetResults)

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Parameters:

facetResults - Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Returns:

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

facetResults

QueryResponse.Builder facetResults(FacetResult... facetResults)

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Parameters:

facetResults - Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

Returns:

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

facetResults

QueryResponse.Builder facetResults(Consumer<FacetResult.Builder>... facetResults)

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #facetResults(List).

Parameters:

facetResults - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#facetResults(List)

totalNumberOfResults

QueryResponse.Builder totalNumberOfResults(Integer totalNumberOfResults)

The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Parameters:

totalNumberOfResults - The total number of items found by the search; however, you can only retrieve up to 100 items. For example, if the search found 192 items, you can only retrieve the first 100 of the items.

Returns:

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