org.apache.flink.runtime.rest.handler.legacy

Class TaskManagersHandler

java.lang.Object

org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

org.apache.flink.runtime.rest.handler.legacy.TaskManagersHandler

All Implemented Interfaces:

RequestHandler

public class TaskManagersHandler
extends AbstractJsonRequestHandler

A request handler that provides an overview over all taskmanagers or details for a single one.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TASK_MANAGER_ID_KEY

Fields inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

executor

Constructor Summary

Constructors

Constructor and Description
TaskManagersHandler(Executor executor, org.apache.flink.api.common.time.Time timeout, MetricFetcher fetcher)

Method Summary

Modifier and Type	Method and Description
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.
CompletableFuture<String>	handleJsonRequest(Map<String,String> pathParams, Map<String,String> queryParams, JobManagerGateway jobManagerGateway) Core method that handles the request and generates the response.

Methods inherited from class org.apache.flink.runtime.rest.handler.legacy.AbstractJsonRequestHandler

handleRequest

Methods inherited from class java.lang.Object

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

Field Detail

TASK_MANAGER_ID_KEY

public static final String TASK_MANAGER_ID_KEY

See Also:

Constant Field Values

Constructor Detail

TaskManagersHandler

public TaskManagersHandler(Executor executor,
                           org.apache.flink.api.common.time.Time timeout,
                           MetricFetcher fetcher)

Method Detail

getPaths

public String[] getPaths()

Description copied from interface: RequestHandler

Returns an array of REST URL's under which this handler can be registered.

Returns:

array containing REST URL's under which this handler can be registered.

handleJsonRequest

public CompletableFuture<String> handleJsonRequest(Map<String,String> pathParams,
                                                   Map<String,String> queryParams,
                                                   JobManagerGateway jobManagerGateway)

Description copied from class: AbstractJsonRequestHandler

Core method that handles the request and generates the response. The method needs to respond with a valid JSON string. Exceptions may be thrown and will be handled.

Specified by:

handleJsonRequest in class AbstractJsonRequestHandler

Parameters:

pathParams - The map of REST path parameters, decoded by the router.

queryParams - The map of query parameters.

jobManagerGateway - to communicate with the JobManager.

Returns:

The JSON string that is the HTTP response.