com.amazonaws.services.cloudsearchv2.model
Class DefineExpressionRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.cloudsearchv2.model.DefineExpressionRequest

All Implemented Interfaces:

Serializable

public class DefineExpressionRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DefineExpression operation.

Configures an Expression for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .

See Also:

AmazonCloudSearch.defineExpression(DefineExpressionRequest), Serialized Form

Constructor Summary

DefineExpressionRequest()

Method Summary

boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
Expression	getExpression() A named expression that can be evaluated at search time.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setExpression(Expression expression) A named expression that can be evaluated at search time.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DefineExpressionRequest	withDomainName(String domainName) A string that represents the name of a domain.
DefineExpressionRequest	withExpression(Expression expression) A named expression that can be evaluated at search time.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

DefineExpressionRequest

public DefineExpressionRequest()

Method Detail

getDomainName

public String getDomainName()

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

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

Returns:

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

setDomainName

public void setDomainName(String domainName)

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

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

Parameters:

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

withDomainName

public DefineExpressionRequest withDomainName(String domainName)

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

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 are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

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

getExpression

public Expression getExpression()

A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

Returns:

A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

setExpression

public void setExpression(Expression expression)

A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

Parameters:

expression - A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

withExpression

public DefineExpressionRequest withExpression(Expression expression)

A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

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

Parameters:

expression - A named expression that can be evaluated at search time. Can be used for sorting and filtering search results and constructing other expressions.

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