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
,StatusToXContentObject
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.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
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
-
Constructor Summary
Constructors Constructor Description ClearScrollResponse(boolean succeeded, int numFreed)
ClearScrollResponse(StreamInput in)
-
Method Summary
Modifier and Type Method Description static ClearScrollResponse
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Parse the clear scroll response body into a newClearScrollResponse
objectint
getNumFreed()
boolean
isSucceeded()
RestStatus
status()
Returns the REST status to make sure it is returned correctlyorg.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
Constructor Details
-
ClearScrollResponse
public ClearScrollResponse(boolean succeeded, int numFreed) -
ClearScrollResponse
- Throws:
java.io.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
Description copied from interface:StatusToXContentObject
Returns the REST status to make sure it is returned correctly- Specified by:
status
in interfaceStatusToXContentObject
-
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContent
public static ClearScrollResponse fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOExceptionParse the clear scroll response body into a newClearScrollResponse
object- Throws:
java.io.IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.
-