public final class SuggestRequest extends BroadcastRequest<SuggestRequest>
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)}).
TransportRequest.Empty
IndicesRequest.Replaceable
indices
headers
Constructor and Description |
---|
SuggestRequest() |
SuggestRequest(String... indices)
Constructs a new suggest request against the provided indices.
|
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) |
indices, indices, indicesOptions, indicesOptions
createTask, getDescription
remoteAddress, remoteAddress
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext
public SuggestRequest()
public SuggestRequest(String... indices)
public ActionRequestValidationException validate()
validate
in class BroadcastRequest<SuggestRequest>
public BytesReference suggest()
public SuggestRequest suggest(BytesReference suggestSource)
public SuggestRequest suggest(SuggestBuilder suggestBuilder)
SuggestBuilder
for phrase and term suggestion lookuppublic SuggestRequest suggest(SuggestBuilder.SuggestionBuilder suggestionBuilder)
SuggestBuilder.SuggestionBuilder
for completion suggestion lookuppublic SuggestRequest suggest(String source)
public String routing()
public SuggestRequest routing(String routing)
public SuggestRequest routing(String... routings)
public SuggestRequest preference(String preference)
public String preference()
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class BroadcastRequest<SuggestRequest>
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class BroadcastRequest<SuggestRequest>
IOException
Copyright © 2009–2016. All rights reserved.