org.elasticsearch.search.suggest.completion

Class CompletionSuggestionBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder<CompletionSuggestionBuilder>

org.elasticsearch.search.suggest.completion.CompletionSuggestionBuilder

All Implemented Interfaces:

ToXContent

public class CompletionSuggestionBuilder
extends SuggestBuilder.SuggestionBuilder<CompletionSuggestionBuilder>

Defines a suggest command based on a prefix, typically to provide "auto-complete" functionality for users as they type search terms. The implementation of the completion service uses FSTs that are created at index-time and so must be defined in the mapping with the type "completion" before indexing.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
CompletionSuggestionBuilder(String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected XContentBuilder	innerToXContent(XContentBuilder builder, ToXContent.Params params)

Methods inherited from class org.elasticsearch.search.suggest.SuggestBuilder.SuggestionBuilder

addCategory, addCategory, addContextField, addContextField, addGeoLocation, addGeoLocation, addGeoLocationWithPrecision, analyzer, field, shardSize, size, text, toXContent

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompletionSuggestionBuilder

public CompletionSuggestionBuilder(String name)

Method Detail

innerToXContent

protected XContentBuilder innerToXContent(XContentBuilder builder,
                              ToXContent.Params params)
                                   throws IOException

Specified by:

innerToXContent in class SuggestBuilder.SuggestionBuilder<CompletionSuggestionBuilder>

Throws:

IOException