org.elasticsearch.rest.action.search

Class RestClearScrollAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.search.RestClearScrollAction

All Implemented Interfaces:

RestHandler

public class RestClearScrollAction
extends BaseRestHandler

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RestChannelConsumer

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

MULTI_ALLOW_EXPLICIT_INDEX

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Constructor Summary

Constructors

Constructor and Description
RestClearScrollAction(Settings settings, RestController controller)

Method Summary

Modifier and Type	Method and Description
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client) Prepare the request for execution.
boolean	supportsPlainText() Indicates if a RestHandler supports plain text bodies

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

handleRequest, responseParams, unrecognized

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

canTripCircuitBreaker, supportsContentStream

Constructor Detail

RestClearScrollAction

public RestClearScrollAction(Settings settings,
                             RestController controller)

Method Detail

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
                                                          NodeClient client)
                                                   throws java.io.IOException

Description copied from class: BaseRestHandler

Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.

Specified by:

prepareRequest in class BaseRestHandler

Parameters:

request - the request to execute

client - client for executing actions on the local node

Returns:

the action to execute

Throws:

java.io.IOException - if an I/O exception occurred parsing the request and preparing for execution

supportsPlainText

public boolean supportsPlainText()

Description copied from interface: RestHandler

Indicates if a RestHandler supports plain text bodies