Enum TermSuggestionBuilder.SuggestMode
java.lang.Object
java.lang.Enum<TermSuggestionBuilder.SuggestMode>
org.elasticsearch.search.suggest.term.TermSuggestionBuilder.SuggestMode
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<TermSuggestionBuilder.SuggestMode>
,java.lang.constant.Constable
,Writeable
- Enclosing class:
- TermSuggestionBuilder
public static enum TermSuggestionBuilder.SuggestMode extends java.lang.Enum<TermSuggestionBuilder.SuggestMode> implements Writeable
An enum representing the valid suggest modes.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Enum Constant Summary
-
Method Summary
Modifier and Type Method Description static TermSuggestionBuilder.SuggestMode
readFromStream(StreamInput in)
static TermSuggestionBuilder.SuggestMode
resolve(java.lang.String str)
abstract org.apache.lucene.search.spell.SuggestMode
toLucene()
static TermSuggestionBuilder.SuggestMode
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name.static TermSuggestionBuilder.SuggestMode[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
-
Enum Constant Details
-
MISSING
Only suggest terms in the suggest text that aren't in the index. This is the default. -
POPULAR
Only suggest terms that occur in more docs then the original suggest text term. -
ALWAYS
Suggest any matching suggest terms based on tokens in the suggest text.
-
-
Method Details
-
values
Returns an array containing the constants of this enum type, in the order they are declared.- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
name
- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
readFromStream
public static TermSuggestionBuilder.SuggestMode readFromStream(StreamInput in) throws java.io.IOException- Throws:
java.io.IOException
-
resolve
-
toLucene
public abstract org.apache.lucene.search.spell.SuggestMode toLucene()
-