java.lang.Object

org.opensearch.rest.action.cat.RestRepositoriesAction

public class RestRepositoriesAction
extends AbstractCatAction

Cat API class to display information about snapshot repositories

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
DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX
Constructor Summary

Constructors

Constructor Description

RestRepositoriesAction()

Method Summary

Modifier and Type	Method	Description
`protected 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.Route`s that this RestHandler is responsible for handling.

prepareRequest, responseParams

getUsageCount, handleRequest, unrecognized

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

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, canTripCircuitBreaker, deprecatedRoutes, replacedRoutes, supportsContentStream

Constructor Details
- RestRepositoriesAction
  
  public RestRepositoriesAction()
Method Details
- routes
  
  public java.util.List<RestHandler.Route> routes()
  
  Description copied from interface: RestHandler
  
  The list of RestHandler.Routes that this RestHandler is responsible for handling.
- doCatRequest
  
  protected BaseRestHandler.RestChannelConsumer doCatRequest(RestRequest request, NodeClient client)
  
  Specified by:
  
  doCatRequest in class AbstractCatAction
- 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.
- documentation
  
  protected void documentation(java.lang.StringBuilder sb)
  
  Specified by:
  
  documentation in class AbstractCatAction
- getTableWithHeader
  
  protected Table getTableWithHeader(RestRequest request)
  
  Specified by:
  
  getTableWithHeader in class AbstractCatAction

Class RestRepositoriesAction