com.amazonaws.services.cloudsearchv2.model

Class DocumentSuggesterOptions

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.DocumentSuggesterOptions

All Implemented Interfaces:

Serializable, Cloneable

public class DocumentSuggesterOptions
extends Object
implements Serializable, Cloneable

Options for a search suggester.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentSuggesterOptions()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentSuggesterOptions	clone()
boolean	equals(Object obj)
String	getFuzzyMatching() The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
String	getSortExpression() An expression that computes a score for each suggestion to control how they are sorted.
String	getSourceField() The name of the index field you want to use for suggestions.
int	hashCode()
void	setFuzzyMatching(String fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
void	setFuzzyMatching(SuggesterFuzzyMatching fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
void	setSortExpression(String sortExpression) An expression that computes a score for each suggestion to control how they are sorted.
void	setSourceField(String sourceField) The name of the index field you want to use for suggestions.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DocumentSuggesterOptions	withFuzzyMatching(String fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
DocumentSuggesterOptions	withFuzzyMatching(SuggesterFuzzyMatching fuzzyMatching) The level of fuzziness allowed when suggesting matches for a string: none, low, or high.
DocumentSuggesterOptions	withSortExpression(String sortExpression) An expression that computes a score for each suggestion to control how they are sorted.
DocumentSuggesterOptions	withSourceField(String sourceField) The name of the index field you want to use for suggestions.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentSuggesterOptions

public DocumentSuggesterOptions()

Method Detail

getSourceField

public String getSourceField()

The name of the index field you want to use for suggestions.

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

Returns:

The name of the index field you want to use for suggestions.

setSourceField

public void setSourceField(String sourceField)

The name of the index field you want to use for suggestions.

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

Parameters:

sourceField - The name of the index field you want to use for suggestions.

withSourceField

public DocumentSuggesterOptions withSourceField(String sourceField)

The name of the index field you want to use for suggestions.

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:

sourceField - The name of the index field you want to use for suggestions.

Returns:

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

getFuzzyMatching

public String getFuzzyMatching()

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Constraints:
Allowed Values: none, low, high

Returns:

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

See Also:

SuggesterFuzzyMatching

setFuzzyMatching

public void setFuzzyMatching(String fuzzyMatching)

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Constraints:
Allowed Values: none, low, high

Parameters:

fuzzyMatching - The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

See Also:

SuggesterFuzzyMatching

withFuzzyMatching

public DocumentSuggesterOptions withFuzzyMatching(String fuzzyMatching)

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

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

Constraints:
Allowed Values: none, low, high

Parameters:

fuzzyMatching - The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Returns:

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

See Also:

SuggesterFuzzyMatching

setFuzzyMatching

public void setFuzzyMatching(SuggesterFuzzyMatching fuzzyMatching)

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Constraints:
Allowed Values: none, low, high

Parameters:

fuzzyMatching - The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

See Also:

SuggesterFuzzyMatching

withFuzzyMatching

public DocumentSuggesterOptions withFuzzyMatching(SuggesterFuzzyMatching fuzzyMatching)

The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

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

Constraints:
Allowed Values: none, low, high

Parameters:

fuzzyMatching - The level of fuzziness allowed when suggesting matches for a string: none, low, or high. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none.

Returns:

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

See Also:

SuggesterFuzzyMatching

getSortExpression

public String getSortExpression()

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Returns:

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

setSortExpression

public void setSortExpression(String sortExpression)

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

Parameters:

sortExpression - An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

withSortExpression

public DocumentSuggesterOptions withSortExpression(String sortExpression)

An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

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

Parameters:

sortExpression - An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the _score value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.

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 DocumentSuggesterOptions clone()

Overrides:

clone in class Object