Class JobDetailsHandler
- 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<JobDetailsInfo,JobMessageParameters>
-
- org.apache.flink.runtime.rest.handler.job.JobDetailsHandler
-
- 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 JobDetailsHandler extends AbstractAccessExecutionGraphHandler<JobDetailsInfo,JobMessageParameters> implements OnlyExecutionGraphJsonArchivist
Handler returning the details for the specified job.
-
-
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 JobDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobDetailsInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Collection<ArchivedJson>
archiveJsonWithPath(AccessExecutionGraph graph)
Returns aCollection
ofArchivedJson
s containing JSON responses and their respective REST URL for a given job.protected JobDetailsInfo
handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph)
-
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
-
JobDetailsHandler
public JobDetailsHandler(GatewayRetriever<? extends RestfulGateway> leaderRetriever, Duration timeout, Map<String,String> responseHeaders, MessageHeaders<EmptyRequestBody,JobDetailsInfo,JobMessageParameters> messageHeaders, ExecutionGraphCache executionGraphCache, Executor executor, MetricFetcher metricFetcher)
-
-
Method Detail
-
handleRequest
protected JobDetailsInfo handleRequest(HandlerRequest<EmptyRequestBody> request, AccessExecutionGraph executionGraph) throws RestHandlerException
- Specified by:
handleRequest
in classAbstractAccessExecutionGraphHandler<JobDetailsInfo,JobMessageParameters>
- Throws:
RestHandlerException
-
archiveJsonWithPath
public Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph) throws IOException
Description copied from interface:OnlyExecutionGraphJsonArchivist
Returns aCollection
ofArchivedJson
s 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 interfaceOnlyExecutionGraphJsonArchivist
- 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
-
-