software.amazon.awssdk.services.kendra.model

Interface QueryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<QueryRequest.Builder,QueryRequest>, KendraRequest.Builder, SdkBuilder<QueryRequest.Builder,QueryRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

QueryRequest

public static interface QueryRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<QueryRequest.Builder,QueryRequest>

Method Summary

Modifier and Type	Method and Description
QueryRequest.Builder	attributeFilter(AttributeFilter attributeFilter) Enables filtered searches based on document attributes.
default QueryRequest.Builder	attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter) Enables filtered searches based on document attributes.
QueryRequest.Builder	facets(Collection<Facet> facets) An array of documents attributes.
QueryRequest.Builder	facets(Consumer<Facet.Builder>... facets) An array of documents attributes.
QueryRequest.Builder	facets(Facet... facets) An array of documents attributes.
QueryRequest.Builder	indexId(String indexId) The unique identifier of the index to search.
QueryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
QueryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
QueryRequest.Builder	pageNumber(Integer pageNumber) Query results are returned in pages the size of the PageSize parameter.
QueryRequest.Builder	pageSize(Integer pageSize) Sets the number of results that are returned in each page of results.
QueryRequest.Builder	queryResultTypeFilter(QueryResultType queryResultTypeFilter) Sets the type of query.
QueryRequest.Builder	queryResultTypeFilter(String queryResultTypeFilter) Sets the type of query.
QueryRequest.Builder	queryText(String queryText) The text to search for.
QueryRequest.Builder	requestedDocumentAttributes(Collection<String> requestedDocumentAttributes) An array of document attributes to include in the response.
QueryRequest.Builder	requestedDocumentAttributes(String... requestedDocumentAttributes) An array of document attributes to include in the response.
default QueryRequest.Builder	sortingConfiguration(Consumer<SortingConfiguration.Builder> sortingConfiguration) Provides information that determines how the results of the query are sorted.
QueryRequest.Builder	sortingConfiguration(SortingConfiguration sortingConfiguration) Provides information that determines how the results of the query are sorted.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

indexId

QueryRequest.Builder indexId(String indexId)

The unique identifier of the index to search. The identifier is returned in the response from the operation.

Parameters:

indexId - The unique identifier of the index to search. The identifier is returned in the response from the operation.

Returns:

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

queryText

QueryRequest.Builder queryText(String queryText)

The text to search for.

Parameters:

queryText - The text to search for.

Returns:

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

attributeFilter

QueryRequest.Builder attributeFilter(AttributeFilter attributeFilter)

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Parameters:

attributeFilter - Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

Returns:

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

attributeFilter

default QueryRequest.Builder attributeFilter(Consumer<AttributeFilter.Builder> attributeFilter)

Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters, NotFilter, and OrAllFilters parameters contain a list of other filters.

The AttributeFilter parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.

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

Parameters:

attributeFilter - a consumer that will call methods on AttributeFilter.Builder

Returns:

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

See Also:

attributeFilter(AttributeFilter)

facets

QueryRequest.Builder facets(Collection<Facet> facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Parameters:

facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Returns:

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

facets

QueryRequest.Builder facets(Facet... facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Parameters:

facets - An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

Returns:

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

facets

QueryRequest.Builder facets(Consumer<Facet.Builder>... facets)

An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.

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 #facets(List).

Parameters:

facets - 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:

#facets(List)

requestedDocumentAttributes

QueryRequest.Builder requestedDocumentAttributes(Collection<String> requestedDocumentAttributes)

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Parameters:

requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Returns:

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

requestedDocumentAttributes

QueryRequest.Builder requestedDocumentAttributes(String... requestedDocumentAttributes)

An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Parameters:

requestedDocumentAttributes - An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.

Returns:

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

queryResultTypeFilter

QueryRequest.Builder queryResultTypeFilter(String queryResultTypeFilter)

Sets the type of query. Only results for the specified query type are returned.

Parameters:

queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

Returns:

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

See Also:

QueryResultType, QueryResultType

queryResultTypeFilter

QueryRequest.Builder queryResultTypeFilter(QueryResultType queryResultTypeFilter)

Sets the type of query. Only results for the specified query type are returned.

Parameters:

queryResultTypeFilter - Sets the type of query. Only results for the specified query type are returned.

Returns:

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

See Also:

QueryResultType, QueryResultType

pageNumber

QueryRequest.Builder pageNumber(Integer pageNumber)

Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Parameters:

pageNumber - Query results are returned in pages the size of the PageSize parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.

Returns:

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

pageSize

QueryRequest.Builder pageSize(Integer pageSize)

Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Parameters:

pageSize - Sets the number of results that are returned in each page of results. The default page size is 10. The maximum number of results returned is 100. If you ask for more than 100 results, only 100 are returned.

Returns:

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

sortingConfiguration

QueryRequest.Builder sortingConfiguration(SortingConfiguration sortingConfiguration)

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Parameters:

sortingConfiguration - Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

Returns:

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

sortingConfiguration

default QueryRequest.Builder sortingConfiguration(Consumer<SortingConfiguration.Builder> sortingConfiguration)

Provides information that determines how the results of the query are sorted. You can set the field that Amazon Kendra should sort the results on, and specify whether the results should be sorted in ascending or descending order. In the case of ties in sorting the results, the results are sorted by relevance.

If you don't provide sorting configuration, the results are sorted by the relevance that Amazon Kendra determines for the result.

This is a convenience 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 sortingConfiguration(SortingConfiguration).

Parameters:

sortingConfiguration - 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:

sortingConfiguration(SortingConfiguration)

overrideConfiguration

QueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

QueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder