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:

Streamable, Writeable, StatusToXContentObject, ToXContent, ToXContentObject

public class ClearScrollResponse
extends ActionResponse
implements StatusToXContentObject

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

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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ClearScrollResponse(boolean succeeded, int numFreed)

Method Summary

Modifier and Type	Method	Description
static ClearScrollResponse	fromXContent(XContentParser parser)	Parse the clear scroll response body into a new ClearScrollResponse object
int	getNumFreed()
boolean	isSucceeded()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
RestStatus	status()	Returns the REST status to make sure it is returned correctly
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

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

Description copied from interface: StatusToXContentObject

Returns the REST status to make sure it is returned correctly

Specified by:

status in interface StatusToXContentObject

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public static ClearScrollResponse fromXContent(XContentParser parser)
                                        throws java.io.IOException

Parse the clear scroll response body into a new ClearScrollResponse object

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionResponse

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionResponse

Throws:

java.io.IOException