Package com.amazonaws.services.cloudsearchdomain.model

Class SuggestRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchdomain.model.SuggestRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class SuggestRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the Suggest request.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
SuggestRequest()

Method Summary

Modifier and Type	Method	Description
SuggestRequest	clone()	Creates a shallow clone of this request.
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

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestRequest

public SuggestRequest()

Method Detail

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.

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.

withQuery

public SuggestRequest withQuery(String query)

Specifies the string for which you want to get suggestions.

Parameters:

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

Returns:

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

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.

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.

withSuggester

public SuggestRequest withSuggester(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.

Returns:

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

setSize

public void setSize(Long size)

Specifies the maximum number of suggestions to return.

Parameters:

size - Specifies the maximum number of suggestions to return.

getSize

public Long getSize()

Specifies the maximum number of suggestions to return.

Returns:

Specifies the maximum number of suggestions to return.

withSize

public SuggestRequest withSize(Long size)

Specifies the maximum number of suggestions to return.

Parameters:

size - Specifies the maximum number of suggestions to return.

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; useful for testing and debugging.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()