com.amazonaws.services.cloudsearch.model

Class DefineRankExpressionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearch.model.DefineRankExpressionRequest

All Implemented Interfaces:

Serializable

public class DefineRankExpressionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DefineRankExpression operation.

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

See Also:

AmazonCloudSearch.defineRankExpression(DefineRankExpressionRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefineRankExpressionRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
NamedRankExpression	getRankExpression() A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setRankExpression(NamedRankExpression rankExpression) A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DefineRankExpressionRequest	withDomainName(String domainName) A string that represents the name of a domain.
DefineRankExpressionRequest	withRankExpression(NamedRankExpression rankExpression) A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

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

DefineRankExpressionRequest

public DefineRankExpressionRequest()

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 DefineRankExpressionRequest 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.

getRankExpression

public NamedRankExpression getRankExpression()

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

Returns:

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

setRankExpression

public void setRankExpression(NamedRankExpression rankExpression)

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

Parameters:

rankExpression - A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

withRankExpression

public DefineRankExpressionRequest withRankExpression(NamedRankExpression rankExpression)

A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

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

Parameters:

rankExpression - A named expression that can be evaluated at search time and used for ranking or thresholding in a search query.

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