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 DescribeSuggesters operation.

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .

See Also:

AmazonCloudSearch.describeSuggesters(DescribeSuggestersRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSuggestersRequest()

Method Summary

Methods

Modifier and Type	Method and 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(Collection<String> suggesterNames) The suggesters you want to describe.
DescribeSuggestersRequest	withSuggesterNames(String... suggesterNames) The suggesters you want to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, 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

getDomainName

public String getDomainName()

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Returns:

The name of the domain you want to describe.

setDomainName

public void setDomainName(String domainName)

The name of the domain you want to describe.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

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

withDomainName

public DescribeSuggestersRequest withDomainName(String domainName)

The name of the domain you want to describe.

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

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

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

Returns:

A reference to this updated 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.

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

Parameters:

suggesterNames - The suggesters you want to describe.

Returns:

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

withSuggesterNames

public DescribeSuggestersRequest withSuggesterNames(Collection<String> suggesterNames)

The suggesters you want to describe.

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

Parameters:

suggesterNames - The suggesters you want to describe.

Returns:

A reference to this updated 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.

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.

withDeployed

public DescribeSuggestersRequest withDeployed(Boolean deployed)

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

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

Parameters:

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

Returns:

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

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.

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

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