org.elasticsearch.action.search

Class SearchScrollRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<SearchScrollRequest>

org.elasticsearch.action.search.SearchScrollRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class SearchScrollRequest
extends ActionRequest<SearchScrollRequest>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Field Summary

Fields inherited from class org.elasticsearch.common.ContextAndHeaderHolder

headers

Constructor Summary

Constructors

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)

Method Summary

Methods

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)

Methods inherited from class org.elasticsearch.transport.TransportRequest

createTask, getDescription

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.common.ContextAndHeaderHolder

contextSize, copyContextAndHeadersFrom, copyContextFrom, copyHeadersFrom, getContext, getFromContext, getFromContext, getHeader, getHeaders, hasHeader, hasInContext, isContextEmpty, putAllInContext, putHeader, putInContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchScrollRequest

public SearchScrollRequest()

SearchScrollRequest

public SearchScrollRequest(String scrollId)

SearchScrollRequest

public 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

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<SearchScrollRequest>

scrollId

public String scrollId()

The scroll id used to scroll the search.

scrollId

public SearchScrollRequest scrollId(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(String keepAlive)

If set, will enable scrolling of the search request for the specified timeout.

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<SearchScrollRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<SearchScrollRequest>

Throws:

IOException