render

Documentation

Index

• type PlanViewer
  • func NewPlanViewer(plan *model.Plan) *PlanViewer
  • func (pv *PlanViewer) SetColor(enabled bool) *PlanViewer
  • func (pv *PlanViewer) ViewByComponent(componentName string) string
  • func (pv *PlanViewer) ViewDAG() string
  • func (pv *PlanViewer) ViewDependencies() string
• type Renderer
  • func NewRenderer() *Renderer
  • func (r *Renderer) DebugDump(plan *model.Plan) string
  • func (r *Renderer) RenderJSON(plan *model.Plan) ([]byte, error)
  • func (r *Renderer) RenderPlan(metadata model.Metadata, jobInstances map[string]*model.JobInstance, ...) *model.Plan
  • func (r *Renderer) RenderPlanWithOrder(metadata model.Metadata, jobInstances map[string]*model.JobInstance, ...) *model.Plan
  • func (r *Renderer) RenderYAML(plan *model.Plan) ([]byte, error)
  • func (r *Renderer) WritePlan(plan *model.Plan, path string) error

Types

type PlanViewer

type PlanViewer struct {
	// contains filtered or unexported fields
}

PlanViewer provides human-readable visualization of a plan DAG

func NewPlanViewer

func NewPlanViewer(plan *model.Plan) *PlanViewer

NewPlanViewer creates a new plan viewer

func (*PlanViewer) SetColor

func (pv *PlanViewer) SetColor(enabled bool) *PlanViewer

func (*PlanViewer) ViewByComponent

func (pv *PlanViewer) ViewByComponent(componentName string) string

ViewByComponent shows a component-focused view with all its jobs

func (*PlanViewer) ViewDAG

func (pv *PlanViewer) ViewDAG() string

ViewDAG returns a human-readable tree view of the DAG

func (*PlanViewer) ViewDependencies

func (pv *PlanViewer) ViewDependencies() string

ViewDependencies shows job dependencies in a focused way

type Renderer

type Renderer struct{}

Renderer materializes job instances into a Plan

func NewRenderer

func NewRenderer() *Renderer

NewRenderer creates a new renderer

func (*Renderer) DebugDump

func (r *Renderer) DebugDump(plan *model.Plan) string

DebugDump outputs debug information about the plan

func (*Renderer) RenderJSON

func (r *Renderer) RenderJSON(plan *model.Plan) ([]byte, error)

RenderJSON renders plan as JSON

func (*Renderer) RenderPlan

func (r *Renderer) RenderPlan(metadata model.Metadata, jobInstances map[string]*model.JobInstance, jobBindings map[string]string) *model.Plan

RenderPlan creates a plan from job instances with JobRegistry bindings

func (*Renderer) RenderPlanWithOrder

func (r *Renderer) RenderPlanWithOrder(metadata model.Metadata, jobInstances map[string]*model.JobInstance, jobBindings map[string]string, jobOrder []string) *model.Plan

RenderPlanWithOrder creates a plan from job instances using a caller-specified order.

func (*Renderer) RenderYAML

func (r *Renderer) RenderYAML(plan *model.Plan) ([]byte, error)

RenderYAML renders plan as YAML

func (*Renderer) WritePlan

func (r *Renderer) WritePlan(plan *model.Plan, path string) error

WritePlan writes plan to file (JSON or YAML based on extension)