Module org.elasticsearch.server

Package org.elasticsearch.action.search

Class ClearScrollResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.search.ClearScrollResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

Direct Known Subclasses:

ClosePointInTimeResponse

public class ClearScrollResponse
extends ActionResponse
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClearScrollResponse(boolean succeeded, int numFreed)
ClearScrollResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static ClosePointInTimeResponse	fromXContent(XContentParser parser)	Parse the clear scroll response body into a new ClearScrollResponse object
int	getNumFreed()
boolean	isSucceeded()
RestStatus	status()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

ClearScrollResponse

public ClearScrollResponse(boolean succeeded,
 int numFreed)

ClearScrollResponse

public ClearScrollResponse(StreamInput in)
                    throws IOException

Throws:

IOException

Method Details

isSucceeded

public boolean isSucceeded()

Returns:

Whether the attempt to clear a scroll was successful.

getNumFreed

public int getNumFreed()

Returns:

The number of search 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()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ClosePointInTimeResponse fromXContent(XContentParser parser)
                                             throws IOException

Parse the clear scroll response body into a new ClearScrollResponse object

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException