org.elasticsearch.action.search

Class ClearScrollRequest

java.lang.Object

org.elasticsearch.common.ContextAndHeaderHolder

org.elasticsearch.transport.TransportMessage<TransportRequest>

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest<ClearScrollRequest>

org.elasticsearch.action.search.ClearScrollRequest

All Implemented Interfaces:

HasContext, HasContextAndHeaders, HasHeaders, Streamable

public class ClearScrollRequest
extends ActionRequest<ClearScrollRequest>

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
ClearScrollRequest()
ClearScrollRequest(ActionRequest request) Creates a clear 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 Summary

Methods

Modifier and Type	Method and Description
void	addScrollId(String scrollId)
List<String>	getScrollIds()
void	readFrom(StreamInput in)
List<String>	scrollIds()
void	scrollIds(List<String> scrollIds)
void	setScrollIds(List<String> scrollIds)
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

ClearScrollRequest

public ClearScrollRequest()

ClearScrollRequest

public ClearScrollRequest(ActionRequest request)

Creates a clear 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

getScrollIds

public List<String> getScrollIds()

setScrollIds

public void setScrollIds(List<String> scrollIds)

addScrollId

public void addScrollId(String scrollId)

scrollIds

public List<String> scrollIds()

scrollIds

public void scrollIds(List<String> scrollIds)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest<ClearScrollRequest>

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest<ClearScrollRequest>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Overrides:

writeTo in class ActionRequest<ClearScrollRequest>

Throws:

IOException