Package org.opensearch.rest.action.cat

Class RestFielddataAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.rest.action.cat.AbstractCatAction

org.opensearch.rest.action.cat.RestFielddataAction

All Implemented Interfaces:

RestHandler

public class RestFielddataAction
extends AbstractCatAction

Cat API class to display information about the size of fielddata fields per node

Opensearch.api:

Nested Class Summary

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

BaseRestHandler.RestChannelConsumer, BaseRestHandler.StreamingRestChannelConsumer, BaseRestHandler.Wrapper

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

RestHandler.DeprecatedRoute, RestHandler.ReplacedRoute, RestHandler.Route

Field Summary

Fields inherited from class org.opensearch.rest.BaseRestHandler

DUPLICATE_PARAMETER_ERROR_MESSAGE, logger, MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestFielddataAction()

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)
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.

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

prepareRequest, responseParams

Methods inherited from class org.opensearch.rest.BaseRestHandler

getUsageCount, handleRequest, parseDeprecatedMasterTimeoutParameter, sendTask, unrecognized, unrecognizedStrings

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.rest.RestHandler

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream, supportsStreaming

Constructor Details

RestFielddataAction

public RestFielddataAction()

Method Details

routes

public List<RestHandler.Route> routes()

Description copied from interface: RestHandler

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

getName

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

doCatRequest

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

Specified by:

doCatRequest in class AbstractCatAction

documentation

protected void documentation(StringBuilder sb)

Specified by:

documentation in class AbstractCatAction

getTableWithHeader

protected Table getTableWithHeader(RestRequest request)

Specified by:

getTableWithHeader in class AbstractCatAction