public class SearchScrollRequest extends ActionRequest implements ToXContentObject
TransportRequest.Empty
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
EMPTY_PARAMS
Constructor and Description |
---|
SearchScrollRequest() |
SearchScrollRequest(java.lang.String scrollId) |
Modifier and Type | Method and Description |
---|---|
Task |
createTask(long id,
java.lang.String type,
java.lang.String action,
TaskId parentTaskId)
Returns the task object that should be used to keep track of the processing of the request.
|
boolean |
equals(java.lang.Object o) |
void |
fromXContent(XContentParser parser)
Parse a search scroll request from a request body provided through the REST layer.
|
java.lang.String |
getDescription()
Returns optional description of the request to be displayed by the task manager
|
int |
hashCode() |
void |
readFrom(StreamInput in)
Set this object's fields from a StreamInput.
|
Scroll |
scroll()
If set, will enable scrolling of the search request.
|
SearchScrollRequest |
scroll(Scroll scroll)
If set, will enable scrolling of the search request.
|
SearchScrollRequest |
scroll(java.lang.String keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
|
SearchScrollRequest |
scroll(TimeValue keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
|
java.lang.String |
scrollId()
The scroll id used to scroll the search.
|
SearchScrollRequest |
scrollId(java.lang.String scrollId) |
java.lang.String |
toString() |
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
ActionRequestValidationException |
validate() |
void |
writeTo(StreamOutput out)
Write this object's fields to a StreamOutput.
|
getShouldStoreResult
getParentTask, setParentTask
remoteAddress, remoteAddress
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
setParentTask
public SearchScrollRequest()
public SearchScrollRequest(java.lang.String scrollId)
public ActionRequestValidationException validate()
validate
in class ActionRequest
public java.lang.String scrollId()
public SearchScrollRequest scrollId(java.lang.String scrollId)
public Scroll scroll()
public SearchScrollRequest scroll(Scroll scroll)
public SearchScrollRequest scroll(TimeValue keepAlive)
public SearchScrollRequest scroll(java.lang.String keepAlive)
public void readFrom(StreamInput in) throws java.io.IOException
Streamable
readFrom
in interface Streamable
readFrom
in class ActionRequest
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Streamable
writeTo
in interface Streamable
writeTo
in class ActionRequest
java.io.IOException
public Task createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId)
TaskAwareRequest
createTask
in interface TaskAwareRequest
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getDescription()
TaskAwareRequest
getDescription
in interface TaskAwareRequest
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
public void fromXContent(XContentParser parser) throws java.io.IOException
java.io.IOException