Package org.elasticsearch.action.search
Class SearchScrollRequest
- java.lang.Object
-
- org.elasticsearch.transport.TransportMessage
-
- org.elasticsearch.transport.TransportRequest
-
- org.elasticsearch.action.ActionRequest
-
- org.elasticsearch.action.search.SearchScrollRequest
-
- All Implemented Interfaces:
Streamable
,Writeable
,ToXContent
,ToXContentObject
,TaskAwareRequest
public class SearchScrollRequest extends ActionRequest implements ToXContentObject
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest
TransportRequest.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 SearchScrollRequest()
SearchScrollRequest(java.lang.String scrollId)
-
Method Summary
Modifier and Type Method Description Task
createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)
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 managerint
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(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.SearchScrollRequest
scroll(Scroll scroll)
If set, will enable scrolling of the search request.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.-
Methods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResult
-
Methods inherited from class org.elasticsearch.transport.TransportRequest
getParentTask, setParentTask
-
Methods inherited from class org.elasticsearch.transport.TransportMessage
remoteAddress, remoteAddress
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
setParentTask
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject
isFragment
-
-
-
-
Method Detail
-
validate
public ActionRequestValidationException validate()
- Specified by:
validate
in classActionRequest
-
scrollId
public java.lang.String scrollId()
The scroll id used to scroll the search.
-
scrollId
public SearchScrollRequest scrollId(java.lang.String scrollId)
-
scroll
public Scroll scroll()
If set, will enable scrolling of the search request.
-
scroll
public SearchScrollRequest scroll(Scroll scroll)
If set, will enable scrolling of the search request.
-
scroll
public SearchScrollRequest scroll(TimeValue keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
-
scroll
public SearchScrollRequest scroll(java.lang.String keepAlive)
If set, will enable scrolling of the search request for the specified timeout.
-
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 interfaceStreamable
- Overrides:
readFrom
in classActionRequest
- 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 interfaceStreamable
- Specified by:
writeTo
in interfaceWriteable
- Overrides:
writeTo
in classActionRequest
- Throws:
java.io.IOException
-
createTask
public Task createTask(long id, java.lang.String type, java.lang.String action, TaskId parentTaskId, java.util.Map<java.lang.String,java.lang.String> headers)
Description copied from interface:TaskAwareRequest
Returns the task object that should be used to keep track of the processing of the request. A request can override this method and return null to avoid being tracked by the task manager.- Specified by:
createTask
in interfaceTaskAwareRequest
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getDescription
public java.lang.String getDescription()
Description copied from interface:TaskAwareRequest
Returns optional description of the request to be displayed by the task manager- Specified by:
getDescription
in interfaceTaskAwareRequest
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
fromXContent
public void fromXContent(XContentParser parser) throws java.io.IOException
Parse a search scroll request from a request body provided through the REST layer. Values that are already be set and are also found while parsing will be overridden.- Throws:
java.io.IOException
-
-