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 Description DocumentSuggesterOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentSuggesterOptions
clone()
boolean
equals(Object obj)
String
getFuzzyMatching()
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.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(SuggesterFuzzyMatching fuzzyMatching)
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.void
setFuzzyMatching(String fuzzyMatching)
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.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(SuggesterFuzzyMatching fuzzyMatching)
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.DocumentSuggesterOptions
withFuzzyMatching(String fuzzyMatching)
The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
.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.
-
-
-
Method Detail
-
setSourceField
public void setSourceField(String sourceField)
The name of the index field you want to use for suggestions.
- Parameters:
sourceField
- The name of the index field you want to use for suggestions.
-
getSourceField
public String getSourceField()
The name of the index field you want to use for suggestions.
- Returns:
- 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.
- Parameters:
sourceField
- The name of the index field you want to use for suggestions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setFuzzyMatching
public void setFuzzyMatching(String fuzzyMatching)
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. 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.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. 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
-
getFuzzyMatching
public String getFuzzyMatching()
The level of fuzziness allowed when suggesting matches for a string:
none
,low
, orhigh
. 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:
- The level of fuzziness allowed when suggesting matches for a
string:
none
,low
, orhigh
. 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
, orhigh
. 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.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. 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:
- Returns a reference to this 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
, orhigh
. 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.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. 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
, orhigh
. 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.- Parameters:
fuzzyMatching
- The level of fuzziness allowed when suggesting matches for a string:none
,low
, orhigh
. 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:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SuggesterFuzzyMatching
-
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.
-
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.
-
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.- 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:
- Returns a reference to this 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DocumentSuggesterOptions clone()
-
-