software.amazon.awssdk.services.kendra.model

Class QueryRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.kendra.model.KendraRequest

software.amazon.awssdk.services.kendra.model.QueryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class QueryRequest
extends KendraRequest
implements ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryRequest.Builder

Method Summary

Modifier and Type	Method and Description
AttributeFilter	attributeFilter() Enables filtered searches based on document attributes.
static QueryRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Facet>	facets() An array of documents attributes.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacets() Returns true if the Facets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasRequestedDocumentAttributes() Returns true if the RequestedDocumentAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	indexId() The unique identifier of the index to search.
Integer	pageNumber() Query results are returned in pages the size of the PageSize parameter.
Integer	pageSize() Sets the number of results that are returned in each page of results.
QueryResultType	queryResultTypeFilter() Sets the type of query.
String	queryResultTypeFilterAsString() Sets the type of query.
String	queryText() The text to search for.
List<String>	requestedDocumentAttributes() An array of document attributes to include in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryRequest.Builder>	serializableBuilderClass()
SortingConfiguration	sortingConfiguration() Provides information that determines how the results of the query are sorted.
QueryRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

indexId

public String indexId()

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

Returns:

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

queryText

public String queryText()

The text to search for.

Returns:

The text to search for.

attributeFilter

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

Returns:

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.

hasFacets

public boolean hasFacets()

Returns true if the Facets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

facets

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasFacets() to see if a value was sent in this field.

Returns:

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.

hasRequestedDocumentAttributes

public boolean hasRequestedDocumentAttributes()

Returns true if the RequestedDocumentAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

requestedDocumentAttributes

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasRequestedDocumentAttributes() to see if a value was sent in this field.

Returns:

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.

queryResultTypeFilter

public QueryResultType queryResultTypeFilter()

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

If the service returns an enum value that is not available in the current SDK version, queryResultTypeFilter will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeFilterAsString().

Returns:

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

See Also:

QueryResultType

queryResultTypeFilterAsString

public String queryResultTypeFilterAsString()

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

If the service returns an enum value that is not available in the current SDK version, queryResultTypeFilter will return QueryResultType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from queryResultTypeFilterAsString().

Returns:

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

See Also:

QueryResultType

pageNumber

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

Returns:

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.

pageSize

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

Returns:

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.

sortingConfiguration

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

Returns:

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.

toBuilder

public QueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryRequest.Builder,QueryRequest>

Specified by:

toBuilder in class KendraRequest

builder

public static QueryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends QueryRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo