QueryResult (AWS SDK for Java

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

Constructors
Constructor and Description
`QueryResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<FacetResult>`	`getFacetResults()` Contains the facet results.
`List<FeaturedResultsItem>`	`getFeaturedResultsItems()` The list of featured result items.
`String`	`getQueryId()` The identifier for the search.
`List<QueryResultItem>`	`getResultItems()` The results of the search.
`List<SpellCorrectedQuery>`	`getSpellCorrectedQueries()` A list of information related to suggested spell corrections for a query.
`Integer`	`getTotalNumberOfResults()` The total number of items found by the search.
`List<Warning>`	`getWarnings()` A list of warning codes and their messages on problems with your query.
`int`	`hashCode()`
`void`	`setFacetResults(Collection<FacetResult> facetResults)` Contains the facet results.
`void`	`setFeaturedResultsItems(Collection<FeaturedResultsItem> featuredResultsItems)` The list of featured result items.
`void`	`setQueryId(String queryId)` The identifier for the search.
`void`	`setResultItems(Collection<QueryResultItem> resultItems)` The results of the search.
`void`	`setSpellCorrectedQueries(Collection<SpellCorrectedQuery> spellCorrectedQueries)` A list of information related to suggested spell corrections for a query.
`void`	`setTotalNumberOfResults(Integer totalNumberOfResults)` The total number of items found by the search.
`void`	`setWarnings(Collection<Warning> warnings)` A list of warning codes and their messages on problems with your query.
`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`	`withFeaturedResultsItems(Collection<FeaturedResultsItem> featuredResultsItems)` The list of featured result items.
`QueryResult`	`withFeaturedResultsItems(FeaturedResultsItem... featuredResultsItems)` The list of featured result items.
`QueryResult`	`withQueryId(String queryId)` The identifier for the search.
`QueryResult`	`withResultItems(Collection<QueryResultItem> resultItems)` The results of the search.
`QueryResult`	`withResultItems(QueryResultItem... resultItems)` The results of the search.
`QueryResult`	`withSpellCorrectedQueries(Collection<SpellCorrectedQuery> spellCorrectedQueries)` A list of information related to suggested spell corrections for a query.
`QueryResult`	`withSpellCorrectedQueries(SpellCorrectedQuery... spellCorrectedQueries)` A list of information related to suggested spell corrections for a query.
`QueryResult`	`withTotalNumberOfResults(Integer totalNumberOfResults)` The total number of items found by the search.
`QueryResult`	`withWarnings(Collection<Warning> warnings)` A list of warning codes and their messages on problems with your query.
`QueryResult`	`withWarnings(Warning... warnings)` A list of warning codes and their messages on problems with your query.

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 identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.
    
    Parameters:
    
    queryId - The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.
  - getQueryId
```
public String getQueryId()
```
    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.
  - withQueryId
```
public QueryResult withQueryId(String queryId)
```
    The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback API.
    
    Parameters:
    
    queryId - The identifier for the search. You also use QueryId to identify the search when using the SubmitFeedback 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 field/attribute key that was specified in the Facets input parameter.
    
    Returns:
    
    Contains the facet results. A FacetResult contains the counts for each field/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 field/attribute key that was specified in the Facets input parameter.
    
    Parameters:
    
    facetResults - Contains the facet results. A FacetResult contains the counts for each field/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 field/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 field/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 field/attribute key that was specified in the Facets input parameter.
    
    Parameters:
    
    facetResults - Contains the facet results. A FacetResult contains the counts for each field/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 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.
    
    Parameters:
    
    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.
  - getTotalNumberOfResults
```
public Integer getTotalNumberOfResults()
```
    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.
  - withTotalNumberOfResults
```
public QueryResult withTotalNumberOfResults(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getWarnings
```
public List<Warning> getWarnings()
```
    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.
    
    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.
  - setWarnings
```
public void setWarnings(Collection<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.
    
    Parameters:
    
    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.
  - withWarnings
```
public QueryResult withWarnings(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setWarnings(java.util.Collection) or withWarnings(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withWarnings
```
public QueryResult withWarnings(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSpellCorrectedQueries
```
public List<SpellCorrectedQuery> getSpellCorrectedQueries()
```
    A list of information related to suggested spell corrections for a query.
    
    Returns:
    
    A list of information related to suggested spell corrections for a query.
  - setSpellCorrectedQueries
```
public void setSpellCorrectedQueries(Collection<SpellCorrectedQuery> spellCorrectedQueries)
```
    A list of information related to suggested spell corrections for a query.
    
    Parameters:
    
    spellCorrectedQueries - A list of information related to suggested spell corrections for a query.
  - withSpellCorrectedQueries
```
public QueryResult withSpellCorrectedQueries(SpellCorrectedQuery... spellCorrectedQueries)
```
    A list of information related to suggested spell corrections for a query.
    
    NOTE: This method appends the values to the existing list (if any). Use setSpellCorrectedQueries(java.util.Collection) or withSpellCorrectedQueries(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    spellCorrectedQueries - A list of information related to suggested spell corrections for a query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSpellCorrectedQueries
```
public QueryResult withSpellCorrectedQueries(Collection<SpellCorrectedQuery> spellCorrectedQueries)
```
    A list of information related to suggested spell corrections for a query.
    
    Parameters:
    
    spellCorrectedQueries - A list of information related to suggested spell corrections for a query.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFeaturedResultsItems
```
public List<FeaturedResultsItem> getFeaturedResultsItems()
```
    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.
    
    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.
  - setFeaturedResultsItems
```
public void setFeaturedResultsItems(Collection<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.
    
    Parameters:
    
    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.
  - withFeaturedResultsItems
```
public QueryResult withFeaturedResultsItems(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setFeaturedResultsItems(java.util.Collection) or withFeaturedResultsItems(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFeaturedResultsItems
```
public QueryResult withFeaturedResultsItems(Collection<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.
    
    Parameters:
    
    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.
    
    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

AWS SDK for Java 1.x API Reference - 1.12.772

Class QueryResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

QueryResult

Method Detail

setQueryId

getQueryId

withQueryId

getResultItems

setResultItems

withResultItems

withResultItems

getFacetResults

setFacetResults

withFacetResults

withFacetResults

setTotalNumberOfResults

getTotalNumberOfResults

withTotalNumberOfResults

getWarnings

setWarnings

withWarnings

withWarnings

getSpellCorrectedQueries

setSpellCorrectedQueries

withSpellCorrectedQueries

withSpellCorrectedQueries

getFeaturedResultsItems

setFeaturedResultsItems

withFeaturedResultsItems

withFeaturedResultsItems

toString

equals

hashCode

clone