org.apache.flink.runtime.webmonitor.history

Interface JsonArchivist

All Known Implementing Classes:

CheckpointConfigHandler, CheckpointingStatisticsHandler, CheckpointStatisticDetailsHandler, DispatcherRestEndpoint, JobAccumulatorsHandler, JobConfigHandler, JobDetailsHandler, JobExceptionsHandler, JobPlanHandler, JobsOverviewHandler, JobVertexDetailsHandler, JobVertexTaskManagersHandler, MiniDispatcherRestEndpoint, SubtaskExecutionAttemptAccumulatorsHandler, SubtaskExecutionAttemptDetailsHandler, SubtasksTimesHandler, TaskCheckpointStatisticDetailsHandler, WebMonitorEndpoint

public interface JsonArchivist

Interface for all classes that want to participate in the archiving of job-related json responses.

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.

Method Detail

archiveJsonWithPath

Collection<ArchivedJson> archiveJsonWithPath(AccessExecutionGraph graph)
                                      throws IOException

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.

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