Package org.apache.flink.runtime.webmonitor.history

Interface JsonArchivist

All Known Subinterfaces:
OnlyExecutionGraphJsonArchivist
All Known Implementing Classes:
CheckpointConfigHandler, CheckpointingStatisticsHandler, CheckpointStatisticDetailsHandler, DispatcherRestEndpoint, JobAccumulatorsHandler, JobConfigHandler, JobDetailsHandler, JobExceptionsHandler, JobManagerJobConfigurationHandler, JobManagerJobEnvironmentHandler, 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 Details

    • archiveJsonWithPath

      Collection<ArchivedJson> archiveJsonWithPath(ExecutionGraphInfo executionGraphInfo) 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:
      executionGraphInfo - AccessExecutionGraph-related information 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