Package org.apache.flink.streaming.api.graph

Interface AdaptiveGraphGenerator

All Known Implementing Classes:
AdaptiveGraphManager
@Internal public interface AdaptiveGraphGenerator
Defines the mechanism for dynamically adapting the graph topology of a Flink job at runtime. The AdaptiveGraphGenerator is responsible for managing and updating the job's execution plan based on runtime events such as the completion of a job vertex. It provides functionalities to generate new job vertices, retrieve the current JobGraph, update the StreamGraph, and track the status of pending stream nodes.

  • Method Summary

    Modifier and Type
    Method
    Description
    JobGraph
    getJobGraph()
    Retrieves the JobGraph representation of the current state of the Flink job.
    StreamGraphContext
    getStreamGraphContext()
    Retrieves the StreamGraphContext which provides a read-only view of the StreamGraph and methods to modify its StreamEdges and StreamNodes.
    List<JobVertex>
    onJobVertexFinished(JobVertexID finishedJobVertexId)
    Responds to notifications that a JobVertex has completed execution.

  • Method Details

    • getJobGraph

      JobGraph getJobGraph()
      Retrieves the JobGraph representation of the current state of the Flink job.
      Returns:
      The JobGraph instance.

    • getStreamGraphContext

      StreamGraphContext getStreamGraphContext()
      Retrieves the StreamGraphContext which provides a read-only view of the StreamGraph and methods to modify its StreamEdges and StreamNodes.
      Returns:
      an instance of StreamGraphContext.

    • onJobVertexFinished

      List<JobVertex> onJobVertexFinished(JobVertexID finishedJobVertexId)
      Responds to notifications that a JobVertex has completed execution. This method generates new job vertices, incorporates them into the JobGraph, and returns a list of the newly created JobVertex instances.
      Parameters:
      finishedJobVertexId - The ID of the completed JobVertex.
      Returns:
      A list of the newly added JobVertex instances to the JobGraph.