Package com.amazonaws.services.cloudsearchv2.model

Class DescribeSuggestersRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DescribeSuggestersRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeSuggestersRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
DescribeSuggestersRequest()

Method Summary

Modifier and Type	Method	Description
DescribeSuggestersRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
Boolean	getDeployed()	Whether to display the deployed configuration (true) or include any pending changes (false).
String	getDomainName()	The name of the domain you want to describe.
List<String>	getSuggesterNames()	The suggesters you want to describe.
int	hashCode()
Boolean	isDeployed()	Whether to display the deployed configuration (true) or include any pending changes (false).
void	setDeployed(Boolean deployed)	Whether to display the deployed configuration (true) or include any pending changes (false).
void	setDomainName(String domainName)	The name of the domain you want to describe.
void	setSuggesterNames(Collection<String> suggesterNames)	The suggesters you want to describe.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
DescribeSuggestersRequest	withDeployed(Boolean deployed)	Whether to display the deployed configuration (true) or include any pending changes (false).
DescribeSuggestersRequest	withDomainName(String domainName)	The name of the domain you want to describe.
DescribeSuggestersRequest	withSuggesterNames(String... suggesterNames)	The suggesters you want to describe.
DescribeSuggestersRequest	withSuggesterNames(Collection<String> suggesterNames)	The suggesters you want to describe.

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

DescribeSuggestersRequest

public DescribeSuggestersRequest()

Method Detail

setDomainName

public void setDomainName(String domainName)

The name of the domain you want to describe.

Parameters:

domainName - The name of the domain you want to describe.

getDomainName

public String getDomainName()

The name of the domain you want to describe.

Returns:

The name of the domain you want to describe.

withDomainName

public DescribeSuggestersRequest withDomainName(String domainName)

The name of the domain you want to describe.

Parameters:

domainName - The name of the domain you want to describe.

Returns:

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

getSuggesterNames

public List<String> getSuggesterNames()

The suggesters you want to describe.

Returns:

The suggesters you want to describe.

setSuggesterNames

public void setSuggesterNames(Collection<String> suggesterNames)

The suggesters you want to describe.

Parameters:

suggesterNames - The suggesters you want to describe.

withSuggesterNames

public DescribeSuggestersRequest withSuggesterNames(String... suggesterNames)

The suggesters you want to describe.

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

Parameters:

suggesterNames - The suggesters you want to describe.

Returns:

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

withSuggesterNames

public DescribeSuggestersRequest withSuggesterNames(Collection<String> suggesterNames)

The suggesters you want to describe.

Parameters:

suggesterNames - The suggesters you want to describe.

Returns:

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

setDeployed

public void setDeployed(Boolean deployed)

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Parameters:

deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

getDeployed

public Boolean getDeployed()

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

withDeployed

public DescribeSuggestersRequest withDeployed(Boolean deployed)

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Parameters:

deployed - Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

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

isDeployed

public Boolean isDeployed()

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

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