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.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFacetResults() Returns true if the FacetResults 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	hasResultItems() Returns true if the ResultItems 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	queryId() The unique identifier for the search.
List<QueryResultItem>	resultItems() The results of the search.
List<SdkField<?>>	sdkFields()
static Class<? extends QueryResponse.Builder>	serializableBuilderClass()
QueryResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	totalNumberOfResults() The total number of items found by the search; however, you can only retrieve up to 100 items.

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 String queryId()

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

Returns:

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

hasResultItems

public boolean hasResultItems()

Returns true if the ResultItems 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.

resultItems

public List<QueryResultItem> resultItems()

The results of the search.

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

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

Returns:

The results of the search.

hasFacetResults

public boolean hasFacetResults()

Returns true if the FacetResults 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.

facetResults

public List<FacetResult> facetResults()

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

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

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

Returns:

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

totalNumberOfResults

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

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 int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo