SuggestBuilder

java.lang.Object
- org.elasticsearch.search.suggest.SuggestBuilder

All Implemented Interfaces:

ToXContent
```
public class SuggestBuilder
extends Object
implements ToXContent
```
Defines how to perform suggesting. This builders allows a number of global options to be specified and an arbitrary number of TermSuggestionBuilder instances.
Suggesting works by suggesting terms that appear in the suggest text that are similar compared to the terms in provided text. These spelling suggestions are based on several options described in this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`static class`	`SuggestBuilder.SuggestionBuilder<T>`

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
`SuggestBuilder()`
`SuggestBuilder(String name)`

Method Summary

All Methods

Instance Methods

Concrete Methods
Modifier and Type	Method and Description
`SuggestBuilder`	`addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion)` Adds an `TermSuggestionBuilder` instance under a user defined name.
`BytesReference`	`buildAsBytes()` Returns a `BytesReference` representing the suggest lookup request.
`BytesReference`	`buildAsBytes(XContentType contentType)` Returns a `BytesReference` representing the suggest lookup request.
`List<SuggestBuilder.SuggestionBuilder<?>>`	`getSuggestion()` Returns all suggestions with the defined names.
`SuggestBuilder`	`setText(String globalText)` Sets the text to provide suggestions for.
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SuggestBuilder
```
public SuggestBuilder()
```
  - SuggestBuilder
```
public SuggestBuilder(String name)
```
- Method Detail
  - setText
```
public SuggestBuilder setText(String globalText)
```
    Sets the text to provide suggestions for. The suggest text is a required option that needs to be set either via this setter or via the setText(String) method.
    The suggest text gets analyzed by the suggest analyzer or the suggest field search analyzer. For each analyzed token, suggested terms are suggested if possible.
  - addSuggestion
```
public SuggestBuilder addSuggestion(SuggestBuilder.SuggestionBuilder<?> suggestion)
```
    Adds an TermSuggestionBuilder instance under a user defined name. The order in which the Suggestions are added, is the same as in the response.
  - getSuggestion
```
public List<SuggestBuilder.SuggestionBuilder<?>> getSuggestion()
```
    Returns all suggestions with the defined names.
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    Specified by:
    
    toXContent in interface ToXContent
    
    Throws:
    
    IOException
  - buildAsBytes
```
public BytesReference buildAsBytes()
```
    Returns a BytesReference representing the suggest lookup request. Builds the request as Requests.CONTENT_TYPE
  - buildAsBytes
```
public BytesReference buildAsBytes(XContentType contentType)
```
    Returns a BytesReference representing the suggest lookup request. Builds the request as the provided contentType

Class SuggestBuilder

Nested Class Summary

Nested Classes

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

Field Summary

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

Constructor Summary

Constructors

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SuggestBuilder

SuggestBuilder

Method Detail

setText

addSuggestion

getSuggestion

toXContent

buildAsBytes

buildAsBytes