Package org.opensearch.plugin.insights.rules.resthandler.top_queries

Class RestTopQueriesAction

java.lang.Object

org.opensearch.rest.BaseRestHandler

org.opensearch.plugin.insights.rules.resthandler.top_queries.RestTopQueriesAction

All Implemented Interfaces:

RestHandler

public class RestTopQueriesAction
extends BaseRestHandler

Rest action to get Top N queries by certain metric type

Opensearch.api:

Nested Class Summary

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

BaseRestHandler.RestChannelConsumer, 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
RestTopQueriesAction()	Constructor for RestTopQueriesAction

Method Summary

Modifier and Type	Method	Description
boolean	canTripCircuitBreaker()
String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)
protected Set<String>	responseParams()
List<RestHandler.Route>	routes()

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, deprecatedRoutes, replacedRoutes, supportsContentStream

Constructor Details

RestTopQueriesAction

public RestTopQueriesAction()

Constructor for RestTopQueriesAction

Method Details

routes

public List<RestHandler.Route> routes()

getName

public String getName()

Specified by:

getName in class BaseRestHandler

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
 NodeClient client)

Specified by:

prepareRequest in class BaseRestHandler

responseParams

protected Set<String> responseParams()

Overrides:

responseParams in class BaseRestHandler

canTripCircuitBreaker

public boolean canTripCircuitBreaker()