Package org.elasticsearch.rest.action.cat

Class RestCatAction

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.RestCatAction

All Implemented Interfaces:

RestHandler

public class RestCatAction
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.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestCatAction(Settings settings, RestController controller, java.util.List<AbstractCatAction> catActions)

Method Summary

Modifier and Type	Method	Description
java.lang.String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)	Prepare the request for execution.

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

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, responseParams, unrecognized

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

RestCatAction

@Inject
public RestCatAction(Settings settings,
                     RestController controller,
                     java.util.List<AbstractCatAction> catActions)

Method Detail

getName

public java.lang.String getName()

Specified by:

getName in class BaseRestHandler

Returns:

the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.

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