org.elasticsearch.action.suggest

Class SuggestRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder<SuggestRequest,SuggestResponse,SuggestRequestBuilder>

org.elasticsearch.action.suggest.SuggestRequestBuilder

public class SuggestRequestBuilder
extends BroadcastOperationRequestBuilder<SuggestRequest,SuggestResponse,SuggestRequestBuilder>

A suggest action request builder.

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor and Description
SuggestRequestBuilder(ElasticsearchClient client, SuggestAction action)

Method Summary

Methods

Modifier and Type	Method and Description
<T> SuggestRequestBuilder	addSuggestion(SuggestBuilder.SuggestionBuilder<T> suggestion) Add a definition for suggestions to the request
protected SuggestRequest	beforeExecute(SuggestRequest request) A callback to additionally process the request before its executed
SuggestRequestBuilder	setPreference(String preference) Sets the preference to execute the search.
SuggestRequestBuilder	setRouting(String... routing) The routing values to control the shards that the search will be executed on.
SuggestRequestBuilder	setRouting(String routing) A comma separated list of routing values to control the shards the search will be executed on.
SuggestRequestBuilder	setSuggestText(String globalText)

Methods inherited from class org.elasticsearch.action.support.broadcast.BroadcastOperationRequestBuilder

setIndices, setIndicesOptions

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestRequestBuilder

public SuggestRequestBuilder(ElasticsearchClient client,
                     SuggestAction action)

Method Detail

addSuggestion

public <T> SuggestRequestBuilder addSuggestion(SuggestBuilder.SuggestionBuilder<T> suggestion)

Add a definition for suggestions to the request

setRouting

public SuggestRequestBuilder setRouting(String routing)

A comma separated list of routing values to control the shards the search will be executed on.

setSuggestText

public SuggestRequestBuilder setSuggestText(String globalText)

setPreference

public SuggestRequestBuilder setPreference(String preference)

Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, _shards:x,y to operate on shards x & y, or a custom value, which guarantees that the same order will be used across different requests.

setRouting

public SuggestRequestBuilder setRouting(String... routing)

The routing values to control the shards that the search will be executed on.

beforeExecute

protected SuggestRequest beforeExecute(SuggestRequest request)

Description copied from class: ActionRequestBuilder

A callback to additionally process the request before its executed

Overrides:

beforeExecute in class ActionRequestBuilder<SuggestRequest,SuggestResponse,SuggestRequestBuilder>

Parameters:

request - Request