Class ExampleCatAction
java.lang.Object
org.opensearch.rest.BaseRestHandler
org.opensearch.rest.action.cat.AbstractCatAction
org.opensearch.example.resthandler.ExampleCatAction
- All Implemented Interfaces:
RestHandler
public class ExampleCatAction extends AbstractCatAction
Example of adding a cat action with a plugin.
-
Nested Class Summary
Nested classes/interfaces inherited from class org.opensearch.rest.BaseRestHandler
BaseRestHandler.RestChannelConsumer, BaseRestHandler.WrapperNested 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
DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX -
Constructor Summary
Constructors Constructor Description ExampleCatAction() -
Method Summary
Modifier and Type Method Description protected BaseRestHandler.RestChannelConsumerdoCatRequest(RestRequest request, NodeClient client)static java.lang.Stringdocumentation()protected voiddocumentation(java.lang.StringBuilder sb)java.lang.StringgetName()protected TablegetTableWithHeader(RestRequest request)java.util.List<RestHandler.Route>routes()Methods inherited from class org.opensearch.rest.action.cat.AbstractCatAction
prepareRequest, responseParamsMethods inherited from class org.opensearch.rest.BaseRestHandler
getUsageCount, handleRequest, unrecognizedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.rest.RestHandler
allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream
-
Constructor Details
-
ExampleCatAction
public ExampleCatAction()
-
-
Method Details
-
routes
-
getName
public java.lang.String getName()- Specified by:
getNamein classBaseRestHandler
-
doCatRequest
- Specified by:
doCatRequestin classAbstractCatAction
-
documentation
protected void documentation(java.lang.StringBuilder sb)- Specified by:
documentationin classAbstractCatAction
-
documentation
public static java.lang.String documentation() -
getTableWithHeader
- Specified by:
getTableWithHeaderin classAbstractCatAction
-