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

Class JobDetailsHandler

java.lang.Object

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

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

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

All Implemented Interfaces:

RequestHandler

public class JobDetailsHandler
extends AbstractExecutionGraphRequestHandler

Request handler that returns details about a job. This includes:

• Dataflow plan
• id, name, and current status
• start time, end time, duration
• number of job vertices in each state (pending, running, finished, failed)
• info about job vertices, including runtime, status, I/O bytes and records, subtasks in each status

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JobDetailsHandler.JobDetailsJsonArchivist Archivist for the JobDetailsHandler.

Field Summary

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

executor

Constructor Summary

Constructors

Constructor and Description
JobDetailsHandler(ExecutionGraphCache executionGraphHolder, Executor executor, MetricFetcher fetcher)

Method Summary

Modifier and Type	Method and Description
static String	createJobDetailsJson(AccessExecutionGraph graph, MetricFetcher fetcher)
String[]	getPaths() Returns an array of REST URL's under which this handler can be registered.
CompletableFuture<String>	handleRequest(AccessExecutionGraph graph, Map<String,String> params)

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

handleJsonRequest

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

Constructor Detail

JobDetailsHandler

public JobDetailsHandler(ExecutionGraphCache executionGraphHolder,
                         Executor executor,
                         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.

handleRequest

public CompletableFuture<String> handleRequest(AccessExecutionGraph graph,
                                               Map<String,String> params)

Specified by:

handleRequest in class AbstractExecutionGraphRequestHandler

createJobDetailsJson

public static String createJobDetailsJson(AccessExecutionGraph graph,
                                          @Nullable
                                          MetricFetcher fetcher)
                                   throws IOException

Throws:

IOException