com.amazonaws.services.cloudsearchdomain.model

Class SuggestRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchdomain.model.SuggestRequest

All Implemented Interfaces:

Serializable

public class SuggestRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the Suggest operation.

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide .

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

See Also:

AmazonCloudSearchDomain.suggest(SuggestRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SuggestRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getQuery() Specifies the string for which you want to get suggestions.
Long	getSize() Specifies the maximum number of suggestions to return.
String	getSuggester() Specifies the name of the suggester to use to find suggested matches.
int	hashCode()
void	setQuery(String query) Specifies the string for which you want to get suggestions.
void	setSize(Long size) Specifies the maximum number of suggestions to return.
void	setSuggester(String suggester) Specifies the name of the suggester to use to find suggested matches.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SuggestRequest	withQuery(String query) Specifies the string for which you want to get suggestions.
SuggestRequest	withSize(Long size) Specifies the maximum number of suggestions to return.
SuggestRequest	withSuggester(String suggester) Specifies the name of the suggester to use to find suggested matches.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SuggestRequest

public SuggestRequest()

Method Detail

getQuery

public String getQuery()

Specifies the string for which you want to get suggestions.

Returns:

Specifies the string for which you want to get suggestions.

setQuery

public void setQuery(String query)

Specifies the string for which you want to get suggestions.

Parameters:

query - Specifies the string for which you want to get suggestions.

withQuery

public SuggestRequest withQuery(String query)

Specifies the string for which you want to get suggestions.

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

Parameters:

query - Specifies the string for which you want to get suggestions.

Returns:

A reference to this updated object so that method calls can be chained together.

getSuggester

public String getSuggester()

Specifies the name of the suggester to use to find suggested matches.

Returns:

Specifies the name of the suggester to use to find suggested matches.

setSuggester

public void setSuggester(String suggester)

Specifies the name of the suggester to use to find suggested matches.

Parameters:

suggester - Specifies the name of the suggester to use to find suggested matches.

withSuggester

public SuggestRequest withSuggester(String suggester)

Specifies the name of the suggester to use to find suggested matches.

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

Parameters:

suggester - Specifies the name of the suggester to use to find suggested matches.

Returns:

A reference to this updated object so that method calls can be chained together.

getSize

public Long getSize()

Specifies the maximum number of suggestions to return.

Returns:

Specifies the maximum number of suggestions to return.

setSize

public void setSize(Long size)

Specifies the maximum number of suggestions to return.

Parameters:

size - Specifies the maximum number of suggestions to return.

withSize

public SuggestRequest withSize(Long size)

Specifies the maximum number of suggestions to return.

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

Parameters:

size - Specifies the maximum number of suggestions to return.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object