com.amazonaws.services.cloudsearchv2.model

Class DescribeDomainsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearchv2.model.DescribeDomainsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeDomainsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeDomains operation.

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0 . For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide .

See Also:

AmazonCloudSearch.describeDomains(DescribeDomainsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeDomainsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeDomainsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<String>	getDomainNames() The names of the domains you want to include in the response.
int	hashCode()
void	setDomainNames(Collection<String> domainNames) The names of the domains you want to include in the response.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeDomainsRequest	withDomainNames(Collection<String> domainNames) The names of the domains you want to include in the response.
DescribeDomainsRequest	withDomainNames(String... domainNames) The names of the domains you want to include in the response.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeDomainsRequest

public DescribeDomainsRequest()

Method Detail

getDomainNames

public List<String> getDomainNames()

The names of the domains you want to include in the response.

Returns:

The names of the domains you want to include in the response.

setDomainNames

public void setDomainNames(Collection<String> domainNames)

The names of the domains you want to include in the response.

Parameters:

domainNames - The names of the domains you want to include in the response.

withDomainNames

public DescribeDomainsRequest withDomainNames(String... domainNames)

The names of the domains you want to include in the response.

NOTE: This method appends the values to the existing list (if any). Use setDomainNames(java.util.Collection) or withDomainNames(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:

domainNames - The names of the domains you want to include in the response.

Returns:

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

withDomainNames

public DescribeDomainsRequest withDomainNames(Collection<String> domainNames)

The names of the domains you want to include in the response.

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

Parameters:

domainNames - The names of the domains you want to include in the response.

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

clone

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