java.lang.Object

org.opensearch.rest.action.admin.cluster.RestRemoteClusterInfoAction

public final class RestRemoteClusterInfoAction
extends BaseRestHandler

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

RestRemoteClusterInfoAction()

Method Summary

Modifier and Type	Method	Description
`boolean`	`canTripCircuitBreaker()`
`java.lang.String`	`getName()`
`BaseRestHandler.RestChannelConsumer`	`prepareRequest(RestRequest request, NodeClient client)`	Prepare the request for execution.
`java.util.List<RestHandler.Route>`	`routes()`	The list of `RestHandler.Route`s that this RestHandler is responsible for handling.

getUsageCount, handleRequest, responseParams, unrecognized

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

allowsUnsafeBuffers, allowSystemIndexAccessByDefault, deprecatedRoutes, replacedRoutes, supportsContentStream

Constructor Details
- RestRemoteClusterInfoAction
  
  public RestRemoteClusterInfoAction()
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.
- 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.
- prepareRequest
  
  public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client)
  
  Description copied from class: BaseRestHandler
  
  Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.
  
  Specified by:
  
  prepareRequest in class BaseRestHandler
  
  Parameters:
  
  request - the request to execute
  
  client - client for executing actions on the local node
  
  Returns:
  
  the action to execute
- canTripCircuitBreaker
  
  public boolean canTripCircuitBreaker()

Class RestRemoteClusterInfoAction