com.amazonaws.services.cloudsearchv2.model

Class Expression

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.Expression

All Implemented Interfaces:

Serializable

public class Expression
extends Object
implements Serializable

A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Expression()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getExpressionName() A string that represents the name of an index field.
String	getExpressionValue() The expression to evaluate for sorting while processing a search request.
int	hashCode()
void	setExpressionName(String expressionName) A string that represents the name of an index field.
void	setExpressionValue(String expressionValue) The expression to evaluate for sorting while processing a search request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Expression	withExpressionName(String expressionName) A string that represents the name of an index field.
Expression	withExpressionValue(String expressionValue) The expression to evaluate for sorting while processing a search request.

Methods inherited from class java.lang.Object

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

Constructor Detail

Expression

public Expression()

Method Detail

getExpressionName

public String getExpressionName()

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

setExpressionName

public void setExpressionName(String expressionName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

expressionName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

withExpressionName

public Expression withExpressionName(String expressionName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

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

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

expressionName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

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

getExpressionValue

public String getExpressionValue()

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Constraints:
Length: 1 - 10240

Returns:

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

setExpressionValue

public void setExpressionValue(String expressionValue)

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

Constraints:
Length: 1 - 10240

Parameters:

expressionValue - The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

withExpressionValue

public Expression withExpressionValue(String expressionValue)

The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

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

Constraints:
Length: 1 - 10240

Parameters:

expressionValue - The expression to evaluate for sorting while processing a search request. The Expression syntax is based on JavaScript expressions. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide.

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