Class CompletionSuggestion
java.lang.Object
org.elasticsearch.search.suggest.Suggest.Suggestion<CompletionSuggestion.Entry>
org.elasticsearch.search.suggest.completion.CompletionSuggestion
- All Implemented Interfaces:
Iterable<CompletionSuggestion.Entry>
,NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
Suggestion response for
CompletionSuggester
results
Response format for each entry:
{
"text" : STRING
"score" : FLOAT
"contexts" : CONTEXTS
}
CONTEXTS : {
"CONTEXT_NAME" : ARRAY,
..
}-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Fields inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion
entries, name, size, TYPE
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionCompletionSuggestion(String name, int size, boolean skipDuplicates)
Creates a completion suggestion given its name, size and whether it should skip duplicates -
Method Summary
Modifier and TypeMethodDescriptionboolean
static CompletionSuggestion
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, String name)
Returns the name of the writeable objectint
hashCode()
boolean
protected CompletionSuggestion.Entry
newEntry(StreamInput in)
reduce(List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce)
Merges the result of another suggestion into this suggestion.void
setShardIndex(int shardIndex)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion
addTerm, fromXContent, getEntries, getName, getSize, iterator, parseEntries, sortComparator, toXContent, trim
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
CompletionSuggestion
Creates a completion suggestion given its name, size and whether it should skip duplicates- Parameters:
name
- The name for the suggestionssize
- The number of suggestions to returnskipDuplicates
- Whether duplicate suggestions should be filtered out
-
CompletionSuggestion
- Throws:
IOException
-
-
Method Details
-
getWriteableName
Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
- Specified by:
getWriteableName
in classSuggest.Suggestion<CompletionSuggestion.Entry>
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classSuggest.Suggestion<CompletionSuggestion.Entry>
- Throws:
IOException
-
getOptions
- Returns:
- the result options for the suggestion
-
hasScoreDocs
public boolean hasScoreDocs()- Returns:
- whether there is any hits for the suggestion
-
equals
- Overrides:
equals
in classSuggest.Suggestion<CompletionSuggestion.Entry>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classSuggest.Suggestion<CompletionSuggestion.Entry>
-
fromXContent
public static CompletionSuggestion fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, String name) throws IOException- Throws:
IOException
-
reduce
Description copied from class:Suggest.Suggestion
Merges the result of another suggestion into this suggestion. For internal usage.- Overrides:
reduce
in classSuggest.Suggestion<CompletionSuggestion.Entry>
-
setShardIndex
public void setShardIndex(int shardIndex) -
newEntry
- Specified by:
newEntry
in classSuggest.Suggestion<CompletionSuggestion.Entry>
- Throws:
IOException
-