org.elasticsearch.action.suggest

クラス 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

すべての実装されたインタフェース:

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)}).

関連項目:

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

ネストされたクラスのサマリー

クラスから継承されたネストされたクラス/インタフェース org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

フィールドのサマリー

クラスから継承されたフィールド org.elasticsearch.action.support.broadcast.BroadcastRequest

indices

クラスから継承されたフィールド org.elasticsearch.common.ContextAndHeaderHolder

headers

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
SuggestRequest()
SuggestRequest(String... indices) Constructs a new suggest request against the provided indices.

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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)

クラスから継承されたメソッド org.elasticsearch.action.support.broadcast.BroadcastRequest

indices, indices, indicesOptions, indicesOptions

クラスから継承されたメソッド org.elasticsearch.transport.TransportRequest

createTask, getDescription

クラスから継承されたメソッド org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

クラスから継承されたメソッド org.elasticsearch.common.ContextAndHeaderHolder

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

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

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.

メソッドの詳細

validate

public ActionRequestValidationException validate()

オーバーライド:

validate クラス内 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

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 BroadcastRequest<SuggestRequest>

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 BroadcastRequest<SuggestRequest>

例外:

IOException

toString

public String toString()

オーバーライド:

toString クラス内 Object