Module org.elasticsearch.server
Class RestGetSnapshotsAction
java.lang.Object
org.elasticsearch.rest.BaseRestHandler
org.elasticsearch.rest.action.admin.cluster.RestGetSnapshotsAction
- All Implemented Interfaces:
RestHandler
Returns information about snapshot
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler
BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumerNested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler
RestHandler.Route -
Field Summary
Fields inherited from class org.elasticsearch.rest.BaseRestHandler
MULTI_ALLOW_EXPLICIT_INDEX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionThe set of path and query parameters that could be present on this handler.getName()prepareRequest(RestRequest request, NodeClient client) Prepare the request for execution.Parameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient).routes()The list ofRestHandler.Routes that this RestHandler is responsible for handling.The set of query parameters accepted by this rest handler,nullif query parameters should not be checked nor validated.Methods inherited from class org.elasticsearch.rest.BaseRestHandler
getUsageCount, handleRequest, responseParams, unrecognizedMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.rest.RestHandler
allowSystemIndexAccessByDefault, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportsBulkContent, supportsContentStream
-
Constructor Details
-
RestGetSnapshotsAction
-
-
Method Details
-
routes
Description copied from class:BaseRestHandlerThe list ofRestHandler.Routes that this RestHandler is responsible for handling.- Specified by:
routesin interfaceRestHandler- Specified by:
routesin classBaseRestHandler
-
getName
- Specified by:
getNamein interfaceRestHandler- Specified by:
getNamein 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.
-
responseParams
Description copied from class:BaseRestHandlerParameters used for controlling the response and thus might not be consumed during preparation of the request execution inBaseRestHandler.prepareRequest(RestRequest, NodeClient).- Overrides:
responseParamsin classBaseRestHandler- Returns:
- a set of parameters used to control the response and thus should not trip strict URL parameter checks.
-
supportedQueryParameters
Description copied from interface:RestHandlerThe set of query parameters accepted by this rest handler,nullif query parameters should not be checked nor validated. TODO - make this not nullable when all handlers have been updated -
allSupportedParameters
Description copied from interface:RestHandlerThe set of path and query parameters that could be present on this handler. This method is only required due to #36785, which conflates query and path parameters inside the rest handler. This method should be overridden to add path parameters toRestHandler.supportedQueryParameters()if the handler has path parameters. This method will be removed whenRestHandler.supportedQueryParameters()andBaseRestHandler.responseParams()are combined. -
prepareRequest
public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException Description copied from class:BaseRestHandlerPrepare 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:
prepareRequestin classBaseRestHandler- Parameters:
request- the request to executeclient- client for executing actions on the local node- Returns:
- the action to execute
- Throws:
IOException- if an I/O exception occurred parsing the request and preparing for execution
-