org.elasticsearch.action.search

Class 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

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable, StatusToXContent, ToXContent

public class ClearScrollResponse
extends ActionResponse
implements StatusToXContent

Nested Class Summary

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

TransportResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
ClearScrollResponse(boolean succeeded, int numFreed)

Method Summary

Methods

Modifier and Type	Method and Description
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)

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, toString, wait, wait, wait

Constructor Detail

ClearScrollResponse

public ClearScrollResponse(boolean succeeded,
                   int numFreed)

Method Detail

isSucceeded

public boolean isSucceeded()

Returns:

Whether the attempt to clear a scroll was successful.

getNumFreed

public int getNumFreed()

Returns:

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()

Description copied from interface: StatusToXContent

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContent

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionResponse

Throws:

IOException