Package org.elasticsearch.rest.action.cat

Class RestShardsAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.rest.action.cat.AbstractCatAction

org.elasticsearch.rest.action.cat.RestShardsAction

All Implemented Interfaces:

RestHandler

public class RestShardsAction
extends AbstractCatAction

Nested Class Summary

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

BaseRestHandler.RestChannelConsumer, BaseRestHandler.Wrapper

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

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestShardsAction()

Method Summary

Modifier and Type	Method	Description
boolean	allowSystemIndexAccessByDefault()	Controls whether requests handled by this class are allowed to to access system indices by default.
BaseRestHandler.RestChannelConsumer	doCatRequest(RestRequest request, NodeClient client)
protected void	documentation(java.lang.StringBuilder sb)
java.lang.String	getName()
protected Table	getTableWithHeader(RestRequest request)
java.util.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, responseParams

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, 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

allowsUnsafeBuffers, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream

Constructor Details

RestShardsAction

public RestShardsAction()

Method Details

routes

public java.util.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

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.

allowSystemIndexAccessByDefault

public boolean allowSystemIndexAccessByDefault()

Description copied from interface: RestHandler

Controls whether requests handled by this class are allowed to to access system indices by default.

Returns:

true if requests handled by this class should be allowed to access system indices.

documentation

protected void documentation(java.lang.StringBuilder sb)

Specified by:

documentation in class AbstractCatAction

doCatRequest

public 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