Module org.elasticsearch.server

Package org.elasticsearch.rest.action.cat

Class RestCatCircuitBreakerAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.AbstractCatAction

org.elasticsearch.rest.action.cat.RestCatCircuitBreakerAction

All Implemented Interfaces:

RestHandler

public class RestCatCircuitBreakerAction
extends AbstractCatAction

Nested Class Summary

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

BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumer

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler

RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestCatCircuitBreakerAction()

Method Summary

Modifier and Type	Method	Description
protected BaseRestHandler.RestChannelConsumer	doCatRequest(RestRequest request, NodeClient client)
protected void	documentation(StringBuilder sb)
String	getName()
protected Table	getTableWithHeader(RestRequest request)
protected Set<String>	responseParams()	Parameters used for controlling the response and thus might not be consumed during preparation of the request execution in BaseRestHandler.prepareRequest(RestRequest, NodeClient).
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.

Methods inherited from class org.elasticsearch.rest.action.cat.AbstractCatAction

prepareRequest

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

allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsContentStream

Constructor Details

RestCatCircuitBreakerAction

public RestCatCircuitBreakerAction()

Method Details

getName

public String getName()

Specified by:

getName in interface RestHandler

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.

routes

public List<RestHandler.Route> routes()

Description copied from class: BaseRestHandler

The list of RestHandler.Routes that this RestHandler is responsible for handling.

Specified by:

routes in interface RestHandler

Specified by:

routes in class BaseRestHandler

documentation

protected void documentation(StringBuilder sb)

Specified by:

documentation in class AbstractCatAction

responseParams

protected Set<String> responseParams()

Description copied from class: BaseRestHandler

Parameters used for controlling the response and thus might not be consumed during preparation of the request execution in BaseRestHandler.prepareRequest(RestRequest, NodeClient).

Overrides:

responseParams in class AbstractCatAction

Returns:

a set of parameters used to control the response and thus should not trip strict URL parameter checks.

doCatRequest

protected BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request,
 NodeClient client)

Specified by:

doCatRequest in class AbstractCatAction

getTableWithHeader

protected Table getTableWithHeader(RestRequest request)

Specified by:

getTableWithHeader in class AbstractCatAction