com.amazonaws.services.cloudsearch.model

Class DescribeRankExpressionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearch.model.DescribeRankExpressionsRequest

All Implemented Interfaces:

Serializable

public class DescribeRankExpressionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeRankExpressions operation.

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

See Also:

AmazonCloudSearch.describeRankExpressions(DescribeRankExpressionsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeRankExpressionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
List<String>	getRankNames() Limits the DescribeRankExpressions response to the specified fields.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setRankNames(Collection<String> rankNames) Limits the DescribeRankExpressions response to the specified fields.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeRankExpressionsRequest	withDomainName(String domainName) A string that represents the name of a domain.
DescribeRankExpressionsRequest	withRankNames(Collection<String> rankNames) Limits the DescribeRankExpressions response to the specified fields.
DescribeRankExpressionsRequest	withRankNames(String... rankNames) Limits the DescribeRankExpressions response to the specified fields.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeRankExpressionsRequest

public DescribeRankExpressionsRequest()

Method Detail

getDomainName

public String getDomainName()

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

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

Returns:

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

setDomainName

public void setDomainName(String domainName)

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

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

Parameters:

domainName - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

withDomainName

public DescribeRankExpressionsRequest withDomainName(String domainName)

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

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 - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Returns:

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

getRankNames

public List<String> getRankNames()

Limits the DescribeRankExpressions response to the specified fields.

Returns:

Limits the DescribeRankExpressions response to the specified fields.

setRankNames

public void setRankNames(Collection<String> rankNames)

Limits the DescribeRankExpressions response to the specified fields.

Parameters:

rankNames - Limits the DescribeRankExpressions response to the specified fields.

withRankNames

public DescribeRankExpressionsRequest withRankNames(String... rankNames)

Limits the DescribeRankExpressions response to the specified fields.

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

Parameters:

rankNames - Limits the DescribeRankExpressions response to the specified fields.

Returns:

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

withRankNames

public DescribeRankExpressionsRequest withRankNames(Collection<String> rankNames)

Limits the DescribeRankExpressions response to the specified fields.

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

Parameters:

rankNames - Limits the DescribeRankExpressions response to the specified fields.

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