public class DocumentSuggesterOptions
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
Options for a search suggester.
Modifier and Type | Field and Description |
---|---|
private java.lang.String |
fuzzyMatching
The level of fuzziness allowed when suggesting matches for a string:
none , low , or high . |
private java.lang.String |
sortExpression
An expression that computes a score for each suggestion to control how
they are sorted.
|
private java.lang.String |
sourceField
The name of the index field you want to use for suggestions.
|
Constructor and Description |
---|
DocumentSuggesterOptions() |
Modifier and Type | Method and Description |
---|---|
DocumentSuggesterOptions |
clone() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getFuzzyMatching()
The level of fuzziness allowed when suggesting matches for a string:
none , low , or high . |
java.lang.String |
getSortExpression()
An expression that computes a score for each suggestion to control how
they are sorted.
|
java.lang.String |
getSourceField()
The name of the index field you want to use for suggestions.
|
int |
hashCode() |
void |
setFuzzyMatching(java.lang.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(java.lang.String sortExpression)
An expression that computes a score for each suggestion to control how
they are sorted.
|
void |
setSourceField(java.lang.String sourceField)
The name of the index field you want to use for suggestions.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DocumentSuggesterOptions |
withFuzzyMatching(java.lang.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(java.lang.String sortExpression)
An expression that computes a score for each suggestion to control how
they are sorted.
|
DocumentSuggesterOptions |
withSourceField(java.lang.String sourceField)
The name of the index field you want to use for suggestions.
|
private java.lang.String sourceField
The name of the index field you want to use for suggestions.
private java.lang.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.
private java.lang.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.
public void setSourceField(java.lang.String sourceField)
The name of the index field you want to use for suggestions.
sourceField
- The name of the index field you want to use for suggestions.public java.lang.String getSourceField()
The name of the index field you want to use for suggestions.
public DocumentSuggesterOptions withSourceField(java.lang.String sourceField)
The name of the index field you want to use for suggestions.
sourceField
- The name of the index field you want to use for suggestions.public void setFuzzyMatching(java.lang.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.
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.SuggesterFuzzyMatching
public java.lang.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.
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.SuggesterFuzzyMatching
public DocumentSuggesterOptions withFuzzyMatching(java.lang.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.
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.SuggesterFuzzyMatching
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.
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.SuggesterFuzzyMatching
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.
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.SuggesterFuzzyMatching
public void setSortExpression(java.lang.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.
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.public java.lang.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.
_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.public DocumentSuggesterOptions withSortExpression(java.lang.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.
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.public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public DocumentSuggesterOptions clone()
clone
in class java.lang.Object