Package org.elasticsearch.action.search

Class ClearScrollRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.search.ClearScrollRequest

All Implemented Interfaces:

Streamable, Writeable, ToXContent, ToXContentObject, TaskAwareRequest

public class ClearScrollRequest
extends ActionRequest
implements ToXContentObject

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

TransportRequest.Empty

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
ClearScrollRequest()

Method Summary

Modifier and Type	Method	Description
void	addScrollId(java.lang.String scrollId)
void	fromXContent(XContentParser parser)
java.util.List<java.lang.String>	getScrollIds()
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.util.List<java.lang.String>	scrollIds()
void	scrollIds(java.util.List<java.lang.String> scrollIds)
void	setScrollIds(java.util.List<java.lang.String> scrollIds)
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 java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

newWriteableReader

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

ClearScrollRequest

public ClearScrollRequest()

Method Detail

getScrollIds

public java.util.List<java.lang.String> getScrollIds()

setScrollIds

public void setScrollIds(java.util.List<java.lang.String> scrollIds)

addScrollId

public void addScrollId(java.lang.String scrollId)

scrollIds

public java.util.List<java.lang.String> scrollIds()

scrollIds

public void scrollIds(java.util.List<java.lang.String> scrollIds)

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

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 interface Streamable

Overrides:

readFrom in class ActionRequest

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 interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public void fromXContent(XContentParser parser)
                  throws java.io.IOException

Throws:

java.io.IOException