software.amazon.awssdk.services.kendra.model

Class QueryResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kendra.model.KendraResponse

software.amazon.awssdk.services.kendra.model.QueryResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	QueryResponse.Builder

Method Summary

Modifier and Type	Method and Description
static QueryResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FacetResult>	facetResults() Contains the facet results.
List<FeaturedResultsItem>	featuredResultsItems() The list of featured result items.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacetResults() For responses, this returns true if the service returned a value for the FacetResults property.
boolean	hasFeaturedResultsItems() For responses, this returns true if the service returned a value for the FeaturedResultsItems property.
int	hashCode()
boolean	hasResultItems() For responses, this returns true if the service returned a value for the ResultItems property.
boolean	hasSpellCorrectedQueries() For responses, this returns true if the service returned a value for the SpellCorrectedQueries property.
boolean	hasWarnings() For responses, this returns true if the service returned a value for the Warnings property.
String	queryId() The identifier for the search.
List<QueryResultItem>	resultItems() The results of the search.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryResponse.Builder>	serializableBuilderClass()
List<SpellCorrectedQuery>	spellCorrectedQueries() A list of information related to suggested spell corrections for a query.
QueryResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalNumberOfResults() The total number of items found by the search.
List<Warning>	warnings() A list of warning codes and their messages on problems with your query.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

queryId

public final String queryId()

The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

Returns:

The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.

hasResultItems

public final boolean hasResultItems()

For responses, this returns true if the service returned a value for the ResultItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

resultItems

public final List<QueryResultItem> resultItems()

The results of the search.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResultItems() method.

Returns:

The results of the search.

hasFacetResults

public final boolean hasFacetResults()

For responses, this returns true if the service returned a value for the FacetResults property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

facetResults

public final List<FacetResult> facetResults()

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFacetResults() method.

Returns:

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

totalNumberOfResults

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

Returns:

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.

hasWarnings

public final boolean hasWarnings()

For responses, this returns true if the service returned a value for the Warnings property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

warnings

public final List<Warning> warnings()

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWarnings() method.

Returns:

A list of warning codes and their messages on problems with your query.

Amazon Kendra currently only supports one type of warning, which is a warning on invalid syntax used in the query. For examples of invalid query syntax, see Searching with advanced query syntax.

hasSpellCorrectedQueries

public final boolean hasSpellCorrectedQueries()

For responses, this returns true if the service returned a value for the SpellCorrectedQueries property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

spellCorrectedQueries

public final List<SpellCorrectedQuery> spellCorrectedQueries()

A list of information related to suggested spell corrections for a query.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSpellCorrectedQueries() method.

Returns:

A list of information related to suggested spell corrections for a query.

hasFeaturedResultsItems

public final boolean hasFeaturedResultsItems()

For responses, this returns true if the service returned a value for the FeaturedResultsItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

featuredResultsItems

public final List<FeaturedResultsItem> featuredResultsItems()

The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFeaturedResultsItems() method.

Returns:

The list of featured result items. Featured results are displayed at the top of the search results page, placed above all other results for certain queries. If there's an exact match of a query, then certain documents are featured in the search results.

toBuilder

public QueryResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<QueryResponse.Builder,QueryResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static QueryResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo