@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SuggestModel extends Object implements Serializable, Cloneable, StructuredPojo
Container for the suggestion information returned in a SuggestResponse
.
Constructor and Description |
---|
SuggestModel() |
Modifier and Type | Method and Description |
---|---|
SuggestModel |
clone() |
boolean |
equals(Object obj) |
Long |
getFound()
The number of documents that were found to match the query string.
|
String |
getQuery()
The query string specified in the suggest request.
|
List<SuggestionMatch> |
getSuggestions()
The documents that match the query string.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setFound(Long found)
The number of documents that were found to match the query string.
|
void |
setQuery(String query)
The query string specified in the suggest request.
|
void |
setSuggestions(Collection<SuggestionMatch> suggestions)
The documents that match the query string.
|
String |
toString()
Returns a string representation of this object.
|
SuggestModel |
withFound(Long found)
The number of documents that were found to match the query string.
|
SuggestModel |
withQuery(String query)
The query string specified in the suggest request.
|
SuggestModel |
withSuggestions(Collection<SuggestionMatch> suggestions)
The documents that match the query string.
|
SuggestModel |
withSuggestions(SuggestionMatch... suggestions)
The documents that match the query string.
|
public void setQuery(String query)
The query string specified in the suggest request.
query
- The query string specified in the suggest request.public String getQuery()
The query string specified in the suggest request.
public SuggestModel withQuery(String query)
The query string specified in the suggest request.
query
- The query string specified in the suggest request.public void setFound(Long found)
The number of documents that were found to match the query string.
found
- The number of documents that were found to match the query string.public Long getFound()
The number of documents that were found to match the query string.
public SuggestModel withFound(Long found)
The number of documents that were found to match the query string.
found
- The number of documents that were found to match the query string.public List<SuggestionMatch> getSuggestions()
The documents that match the query string.
public void setSuggestions(Collection<SuggestionMatch> suggestions)
The documents that match the query string.
suggestions
- The documents that match the query string.public SuggestModel withSuggestions(SuggestionMatch... suggestions)
The documents that match the query string.
NOTE: This method appends the values to the existing list (if any). Use
setSuggestions(java.util.Collection)
or withSuggestions(java.util.Collection)
if you want to
override the existing values.
suggestions
- The documents that match the query string.public SuggestModel withSuggestions(Collection<SuggestionMatch> suggestions)
The documents that match the query string.
suggestions
- The documents that match the query string.public String toString()
toString
in class Object
Object.toString()
public SuggestModel clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.