org.elasticsearch.action.suggest

Class SuggestRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<T>

org.elasticsearch.action.support.broadcast.BroadcastRequest<SuggestRequest>

org.elasticsearch.action.suggest.SuggestRequest

All Implemented Interfaces:

IndicesRequest, IndicesRequest.Replaceable, HasContext, HasContextAndHeaders, HasHeaders, Streamable

public final class SuggestRequest
extends BroadcastRequest<SuggestRequest>

A request to get suggestions for corrections of phrases. Best created with Requests.suggestRequest(String...).

The request requires the suggest query source to be set either using suggest(org.elasticsearch.common.bytes.BytesReference) / suggest(org.elasticsearch.common.bytes.BytesReference) or by using suggest(org.elasticsearch.search.suggest.SuggestBuilder) (Best created using the {link @org.elasticsearch.search.suggest.SuggestBuilders)}).

See Also:

SuggestResponse, Client.suggest(SuggestRequest), Requests.suggestRequest(String...), SuggestBuilders

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Field Summary

Fields inherited from class org.elasticsearch.action.support.broadcast.BroadcastRequest

indices

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

Constructor and Description
SuggestRequest()
SuggestRequest(String... indices) Constructs a new suggest request against the provided indices.

Method Summary

Methods

Modifier and Type	Method and Description
String	preference()
SuggestRequest	preference(String preference)
void	readFrom(StreamInput in)
String	routing() A comma separated list of routing values to control the shards the search will be executed on.
SuggestRequest	routing(String... routings) The routing values to control the shards that the search will be executed on.
SuggestRequest	routing(String routing) A comma separated list of routing values to control the shards the search will be executed on.
BytesReference	suggest() The Phrase to get correction suggestions for
SuggestRequest	suggest(BytesReference suggestSource) set a new source for the suggest query
SuggestRequest	suggest(String source)
SuggestRequest	suggest(SuggestBuilder.SuggestionBuilder suggestionBuilder) set a new source using a SuggestBuilder.SuggestionBuilder for completion suggestion lookup
SuggestRequest	suggest(SuggestBuilder suggestBuilder) set a new source using a SuggestBuilder for phrase and term suggestion lookup
String	toString()
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

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

indices, indices, indicesOptions, indicesOptions

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestRequest

public SuggestRequest()

SuggestRequest

public SuggestRequest(String... indices)

Constructs a new suggest request against the provided indices. No indices provided means it will run against all indices.

Method Detail

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BroadcastRequest<SuggestRequest>

suggest

public BytesReference suggest()

The Phrase to get correction suggestions for

suggest

public SuggestRequest suggest(BytesReference suggestSource)

set a new source for the suggest query

suggest

public SuggestRequest suggest(SuggestBuilder suggestBuilder)

set a new source using a SuggestBuilder for phrase and term suggestion lookup

suggest

public SuggestRequest suggest(SuggestBuilder.SuggestionBuilder suggestionBuilder)

set a new source using a SuggestBuilder.SuggestionBuilder for completion suggestion lookup

suggest

public SuggestRequest suggest(String source)

routing

public String routing()

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

routing

public SuggestRequest routing(String routing)

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

routing

public SuggestRequest routing(String... routings)

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

preference

public SuggestRequest preference(String preference)

preference

public String preference()

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class BroadcastRequest<SuggestRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class BroadcastRequest<SuggestRequest>

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object