public class SearchScrollRequest extends ActionRequest<SearchScrollRequest>
TransportRequest.Empty
headers
Constructor and Description |
---|
SearchScrollRequest() |
SearchScrollRequest(ActionRequest request)
Creates a scroll request caused by some other request, which is provided as an
argument so that its headers and context can be copied to the new request
|
SearchScrollRequest(String scrollId) |
Modifier and Type | Method and Description |
---|---|
void |
readFrom(StreamInput in) |
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(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.
|
String |
scrollId()
The scroll id used to scroll the search.
|
SearchScrollRequest |
scrollId(String scrollId) |
ActionRequestValidationException |
validate() |
void |
writeTo(StreamOutput out) |
createTask, getDescription
remoteAddress, remoteAddress
contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext
public SearchScrollRequest()
public SearchScrollRequest(String scrollId)
public SearchScrollRequest(ActionRequest request)
public ActionRequestValidationException validate()
validate
in class ActionRequest<SearchScrollRequest>
public String scrollId()
public SearchScrollRequest scrollId(String scrollId)
public Scroll scroll()
public SearchScrollRequest scroll(Scroll scroll)
public SearchScrollRequest scroll(TimeValue keepAlive)
public SearchScrollRequest scroll(String keepAlive)
public void readFrom(StreamInput in) throws IOException
readFrom
in interface Streamable
readFrom
in class ActionRequest<SearchScrollRequest>
IOException
public void writeTo(StreamOutput out) throws IOException
writeTo
in interface Streamable
writeTo
in class ActionRequest<SearchScrollRequest>
IOException
Copyright © 2009–2016. All rights reserved.