public class ClearScrollResponse extends ActionResponse implements StatusToXContentObject
TransportResponse.Empty
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
EMPTY_PARAMS
Constructor and Description |
---|
ClearScrollResponse(boolean succeeded,
int numFreed) |
Modifier and Type | Method and 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.
|
remoteAddress, remoteAddress
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isFragment
public boolean isSucceeded()
public int getNumFreed()
0
the assumption can be made,
that the scroll id specified in the request did not exist. (never existed, was expired, or completely consumed)public RestStatus status()
StatusToXContentObject
status
in interface StatusToXContentObject
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
public static ClearScrollResponse fromXContent(XContentParser parser) throws java.io.IOException
ClearScrollResponse
objectjava.io.IOException
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionResponse
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class ActionResponse
java.io.IOException