Class RestClusterHealthAction
- java.lang.Object
-
- org.elasticsearch.rest.BaseRestHandler
-
- org.elasticsearch.rest.action.admin.cluster.RestClusterHealthAction
-
- All Implemented Interfaces:
RestHandler
public class RestClusterHealthAction extends BaseRestHandler
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RestChannelConsumer
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.rest.BaseRestHandler
DEFAULT_INCLUDE_TYPE_NAME_POLICY, INCLUDE_TYPE_NAME_PARAMETER, logger, MULTI_ALLOW_EXPLICIT_INDEX
-
-
Constructor Summary
Constructors Constructor Description RestClusterHealthAction(RestController controller)
-
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.protected java.util.Set<java.lang.String>
responseParams()
Parameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.-
Methods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, unrecognized
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.rest.RestHandler
supportsContentStream
-
-
-
-
Constructor Detail
-
RestClusterHealthAction
public RestClusterHealthAction(RestController controller)
-
-
Method Detail
-
getName
public java.lang.String getName()
- Specified by:
getName
in classBaseRestHandler
- 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) throws java.io.IOException
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 overrideBaseRestHandler.responseParams()
to indicate such params.- Specified by:
prepareRequest
in classBaseRestHandler
- Parameters:
request
- the request to executeclient
- client for executing actions on the local node- Returns:
- the action to execute
- Throws:
java.io.IOException
- if an I/O exception occurred parsing the request and preparing for execution
-
responseParams
protected java.util.Set<java.lang.String> responseParams()
Description copied from class:BaseRestHandler
Parameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient)
.- Overrides:
responseParams
in classBaseRestHandler
- Returns:
- a set of parameters used to control the response and thus should not trip strict URL parameter checks.
-
canTripCircuitBreaker
public boolean canTripCircuitBreaker()
-
-