Class CompletionSuggestion
java.lang.Object
org.elasticsearch.search.suggest.Suggest.Suggestion<CompletionSuggestion.Entry>
org.elasticsearch.search.suggest.completion.CompletionSuggestion
- All Implemented Interfaces:
java.lang.Iterable<CompletionSuggestion.Entry>
,NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
public final class CompletionSuggestion extends Suggest.Suggestion<CompletionSuggestion.Entry>
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 Modifier and Type Class Description static class
CompletionSuggestion.Entry
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 Modifier and Type Field Description static int
TYPE
Deprecated.Fields inherited from class org.elasticsearch.search.suggest.Suggest.Suggestion
entries, name, size
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Constructor Description CompletionSuggestion(java.lang.String name, int size, boolean skipDuplicates)
Creates a completion suggestion given its name, size and whether it should skip duplicatesCompletionSuggestion(StreamInput in)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object other)
static CompletionSuggestion
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser, java.lang.String name)
java.util.List<CompletionSuggestion.Entry.Option>
getOptions()
java.lang.String
getWriteableName()
Returns the name of the writeable objectint
getWriteableType()
Returns a integer representing the type of the suggestion.int
hashCode()
boolean
hasScoreDocs()
protected CompletionSuggestion.Entry
newEntry(StreamInput in)
CompletionSuggestion
reduce(java.util.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
-
Field Details
-
TYPE
@Deprecated public static final int TYPEDeprecated.- See Also:
- Constant Field Values
-
-
Constructor Details
-
CompletionSuggestion
public CompletionSuggestion(java.lang.String name, int size, boolean skipDuplicates)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:
java.io.IOException
-
-
Method Details
-
getWriteableName
public java.lang.String 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:
java.io.IOException
-
getOptions
- Returns:
- the result options for the suggestion
-
hasScoreDocs
public boolean hasScoreDocs()- Returns:
- whether there is any hits for the suggestion
-
equals
public boolean equals(java.lang.Object other)- 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, java.lang.String name) throws java.io.IOException- Throws:
java.io.IOException
-
reduce
public CompletionSuggestion reduce(java.util.List<Suggest.Suggestion<CompletionSuggestion.Entry>> toReduce)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) -
getWriteableType
public int getWriteableType()Description copied from class:Suggest.Suggestion
Returns a integer representing the type of the suggestion. This is used for internal serialization over the network. This class is now serialized as a NamedWriteable and this method only remains for backwards compatibility- Overrides:
getWriteableType
in classSuggest.Suggestion<CompletionSuggestion.Entry>
-
newEntry
- Specified by:
newEntry
in classSuggest.Suggestion<CompletionSuggestion.Entry>
- Throws:
java.io.IOException
-