com.amazonaws.services.kendra.model

Class QueryResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.kendra.model.QueryResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class QueryResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
QueryResult()

Method Summary

Modifier and Type	Method and Description
QueryResult	clone()
boolean	equals(Object obj)
List<FacetResult>	getFacetResults() Contains the facet results.
String	getQueryId() The unique identifier for the search.
List<QueryResultItem>	getResultItems() The results of the search.
Integer	getTotalNumberOfResults() The number of items returned by the search.
int	hashCode()
void	setFacetResults(Collection<FacetResult> facetResults) Contains the facet results.
void	setQueryId(String queryId) The unique identifier for the search.
void	setResultItems(Collection<QueryResultItem> resultItems) The results of the search.
void	setTotalNumberOfResults(Integer totalNumberOfResults) The number of items returned by the search.
String	toString() Returns a string representation of this object.
QueryResult	withFacetResults(Collection<FacetResult> facetResults) Contains the facet results.
QueryResult	withFacetResults(FacetResult... facetResults) Contains the facet results.
QueryResult	withQueryId(String queryId) The unique identifier for the search.
QueryResult	withResultItems(Collection<QueryResultItem> resultItems) The results of the search.
QueryResult	withResultItems(QueryResultItem... resultItems) The results of the search.
QueryResult	withTotalNumberOfResults(Integer totalNumberOfResults) The number of items returned by the search.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryResult

public QueryResult()

Method Detail

setQueryId

public void setQueryId(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.

getQueryId

public String getQueryId()

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.

withQueryId

public QueryResult withQueryId(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.

getResultItems

public List<QueryResultItem> getResultItems()

The results of the search.

Returns:

The results of the search.

setResultItems

public void setResultItems(Collection<QueryResultItem> resultItems)

The results of the search.

Parameters:

resultItems - The results of the search.

withResultItems

public QueryResult withResultItems(QueryResultItem... resultItems)

The results of the search.

NOTE: This method appends the values to the existing list (if any). Use setResultItems(java.util.Collection) or withResultItems(java.util.Collection) if you want to override the existing values.

Parameters:

resultItems - The results of the search.

Returns:

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

withResultItems

public QueryResult withResultItems(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.

getFacetResults

public List<FacetResult> getFacetResults()

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

Returns:

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

setFacetResults

public void setFacetResults(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.

withFacetResults

public QueryResult withFacetResults(FacetResult... facetResults)

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

NOTE: This method appends the values to the existing list (if any). Use setFacetResults(java.util.Collection) or withFacetResults(java.util.Collection) if you want to override the existing values.

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.

withFacetResults

public QueryResult withFacetResults(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.

setTotalNumberOfResults

public void setTotalNumberOfResults(Integer totalNumberOfResults)

The number of items returned by the search. Use this to determine when you have requested the last set of results.

Parameters:

totalNumberOfResults - The number of items returned by the search. Use this to determine when you have requested the last set of results.

getTotalNumberOfResults

public Integer getTotalNumberOfResults()

The number of items returned by the search. Use this to determine when you have requested the last set of results.

Returns:

The number of items returned by the search. Use this to determine when you have requested the last set of results.

withTotalNumberOfResults

public QueryResult withTotalNumberOfResults(Integer totalNumberOfResults)

The number of items returned by the search. Use this to determine when you have requested the last set of results.

Parameters:

totalNumberOfResults - The number of items returned by the search. Use this to determine when you have requested the last set of results.

Returns:

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

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public QueryResult clone()

Overrides:

clone in class Object