org.elasticsearch.action.search

クラス ClearScrollResponse

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportResponse>

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.search.ClearScrollResponse

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

HasContext, HasContextAndHeaders, HasHeaders, Streamable, StatusToXContent, ToXContent

public class ClearScrollResponse
extends ActionResponse
implements StatusToXContent

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

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

TransportResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー

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

headers

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

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

コンストラクタ

コンストラクタと説明
ClearScrollResponse(boolean succeeded, int numFreed)

メソッドのサマリー

修飾子とタイプ	メソッドと説明
int	getNumFreed()
boolean	isSucceeded()
void	readFrom(StreamInput in)
RestStatus	status() Returns the REST status to make sure it is returned correctly
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

クラスから継承されたメソッド 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, toString, wait, wait, wait

コンストラクタの詳細

ClearScrollResponse

public ClearScrollResponse(boolean succeeded,
                           int numFreed)

メソッドの詳細

isSucceeded

public boolean isSucceeded()

戻り値:

Whether the attempt to clear a scroll was successful.

getNumFreed

public int getNumFreed()

戻り値:

The number of seach contexts that were freed. If this is 0 the assumption can be made, that the scroll id specified in the request did not exist. (never existed, was expired, or completely consumed)

status

public RestStatus status()

インタフェースからコピーされた説明: StatusToXContent

Returns the REST status to make sure it is returned correctly

定義:

status インタフェース内 StatusToXContent

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException

定義:

toXContent インタフェース内 ToXContent

例外:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

定義:

readFrom インタフェース内 Streamable

オーバーライド:

readFrom クラス内 ActionResponse

例外:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

定義:

writeTo インタフェース内 Streamable

オーバーライド:

writeTo クラス内 ActionResponse

例外:

IOException