org.apache.flink.runtime.rest.handler.job

Class SubtasksTimesHandler

java.lang.Object

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler<RoutedRequest>

org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler<T>

org.apache.flink.runtime.rest.handler.AbstractHandler<T,R,M>

org.apache.flink.runtime.rest.handler.AbstractRestHandler<RestfulGateway,EmptyRequestBody,R,M>

org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler<R,M>

org.apache.flink.runtime.rest.handler.job.AbstractJobVertexHandler<SubtasksTimesInfo,JobVertexMessageParameters>

org.apache.flink.runtime.rest.handler.job.SubtasksTimesHandler

All Implemented Interfaces:

AutoCloseable, JsonArchivist, org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler, org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler, org.apache.flink.util.AutoCloseableAsync

public class SubtasksTimesHandler
extends AbstractJobVertexHandler<SubtasksTimesInfo,JobVertexMessageParameters>
implements JsonArchivist

Request handler for the subtasks times info.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

log, MAPPER

Fields inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

leaderRetriever, logger, responseHeaders, timeout

Constructor Summary

Constructors

Constructor and Description
SubtasksTimesHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, org.apache.flink.api.common.time.Time timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtasksTimesInfo,JobVertexMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor)

Method Summary

Modifier and Type	Method and Description
Collection<ArchivedJson>	archiveJsonWithPath(AccessExecutionGraph graph) Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.
protected SubtasksTimesInfo	handleRequest(HandlerRequest<EmptyRequestBody,JobVertexMessageParameters> request, AccessExecutionJobVertex jobVertex) Called for each request after the corresponding AccessExecutionJobVertex has been retrieved from the AccessExecutionGraph.

Methods inherited from class org.apache.flink.runtime.rest.handler.job.AbstractJobVertexHandler

handleRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.job.AbstractExecutionGraphHandler

handleRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractRestHandler

getMessageHeaders, respondToRequest

Methods inherited from class org.apache.flink.runtime.rest.handler.AbstractHandler

closeAsync, closeHandlerAsync, respondAsLeader

Methods inherited from class org.apache.flink.runtime.rest.handler.LeaderRetrievalHandler

channelRead0

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Methods inherited from interface org.apache.flink.shaded.netty4.io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

SubtasksTimesHandler

public SubtasksTimesHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                            org.apache.flink.api.common.time.Time timeout,
                            Map<String,String> responseHeaders,
                            MessageHeaders<EmptyRequestBody,SubtasksTimesInfo,JobVertexMessageParameters> messageHeaders,
                            ExecutionGraphCache executionGraphCache,
                            Executor executor)

Method Detail

handleRequest

protected SubtasksTimesInfo handleRequest(HandlerRequest<EmptyRequestBody,JobVertexMessageParameters> request,
                                          AccessExecutionJobVertex jobVertex)

Description copied from class: AbstractJobVertexHandler

Called for each request after the corresponding AccessExecutionJobVertex has been retrieved from the AccessExecutionGraph.

Specified by:

handleRequest in class AbstractJobVertexHandler<SubtasksTimesInfo,JobVertexMessageParameters>

Parameters:

request - the request

jobVertex - the execution job vertex

Returns:

the response

archiveJsonWithPath

public Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph)
                                             throws IOException

Description copied from interface: JsonArchivist

Returns a Collection of ArchivedJsons containing JSON responses and their respective REST URL for a given job.

The collection should contain one entry for every response that could be generated for the given job, for example one entry for each task. The REST URLs should be unique and must not contain placeholders.

Specified by:

archiveJsonWithPath in interface JsonArchivist

Parameters:

graph - AccessExecutionGraph for which the responses should be generated

Returns:

Collection containing an ArchivedJson for every response that could be generated for the given job

Throws:

IOException - thrown if the JSON generation fails