If you want to visualize a job, you can call the display or the visualize method of the JobClient instance.

  • display is designed to be used in an interactive environment such as a Jupyter notebook, and display the visualization directly in the notebook
  • visualize is designed to be used in a non-interactive environment and return a string - the job diagram as a SVG image

Both methods have the same parameters.

​
Parameters

job
Job

The job to visualize.

direction
str

An explicit direction for the diagram to flow towards. See the relevant section in the D2 docs for more detail. Valid values are up, down, right, left. Defaults to down.

layout
str

A layout engine to use for the diagram. See D2 layout engines for more information. Valid values are dagre and elk. Defaults to dagre.

sketchy
bool

Whether to use a sketchy, hand-drawn style for the diagram. Defaults to True.

Was this page helpful?

Cancelling a JobCluster Management