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

Class SubtaskExecutionAttemptDetailsHandler

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.AbstractAccessExecutionGraphHandler<R,M>

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

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

org.apache.flink.runtime.rest.handler.job.AbstractSubtaskAttemptHandler<SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters>

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

All Implemented Interfaces:

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

public class SubtaskExecutionAttemptDetailsHandler
extends AbstractSubtaskAttemptHandler<SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters>
implements OnlyExecutionGraphJsonArchivist

Handler of specific sub task execution attempt.

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	Description
SubtaskExecutionAttemptDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)	Instantiates a new subtask execution attempt details handler.

Method Summary

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

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

handleRequest

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

handleRequest

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

handleRequest

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

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, getTimeout

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

Methods inherited from interface org.apache.flink.runtime.webmonitor.history.OnlyExecutionGraphJsonArchivist

archiveJsonWithPath

Constructor Detail

SubtaskExecutionAttemptDetailsHandler

public SubtaskExecutionAttemptDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever,
                                             Duration timeout,
                                             Map<String,String> responseHeaders,
                                             MessageHeaders<EmptyRequestBody,SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters> messageHeaders,
                                             ExecutionGraphCache executionGraphCache,
                                             Executor executor,
                                             MetricFetcher metricFetcher)

Instantiates a new subtask execution attempt details handler.

Parameters:

leaderRetriever - the leader retriever

timeout - the timeout

responseHeaders - the response headers

messageHeaders - the message headers

executionGraphCache - the execution graph cache

executor - the executor

Method Detail

handleRequest

protected SubtaskExecutionAttemptDetailsInfo handleRequest(HandlerRequest<EmptyRequestBody> request,
                                                           AccessExecution execution)
                                                    throws RestHandlerException

Description copied from class: AbstractSubtaskAttemptHandler

Called for each request after the corresponding AccessExecution has been retrieved from the AccessExecutionVertex.

Specified by:

handleRequest in class AbstractSubtaskAttemptHandler<SubtaskExecutionAttemptDetailsInfo,SubtaskAttemptMessageParameters>

Parameters:

request - the request

execution - the execution

Returns:

the response

Throws:

RestHandlerException - the rest handler exception

archiveJsonWithPath

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

Description copied from interface: OnlyExecutionGraphJsonArchivist

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 OnlyExecutionGraphJsonArchivist

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