plan

Documentation

Index

• Variables
• func Pipeline(ctx context.Context, g *graph.Graph, id string, factory *render.Factory) executor.Pipeline
• func Plan(ctx context.Context, in *graph.Graph) (*graph.Graph, error)
• func WithNotify(ctx context.Context, in *graph.Graph, notify *graph.Notifier) (*graph.Graph, error)
• type Result
  • func (r *Result) Changes() map[string]resource.Diff
  • func (r *Result) Error() error
  • func (r *Result) GetStatus() resource.TaskStatus
  • func (r *Result) GetTask() (resource.Task, bool)
  • func (r *Result) HasChanges() bool
  • func (r *Result) Messages() []string
  • func (r *Result) Warning() string

Variables

var ErrTreeContainsErrors = errors.New("plan has errors, check graph")

ErrTreeContainsErrors is a signal value to indicate errors in the graph

Functions

func Pipeline

func Pipeline(ctx context.Context, g *graph.Graph, id string, factory *render.Factory) executor.Pipeline

Pipeline generates a pipeline to evaluate a single graph node

func Plan

func Plan(ctx context.Context, in *graph.Graph) (*graph.Graph, error)

Plan the execution of a Graph of resource.Tasks

func WithNotify

func WithNotify(ctx context.Context, in *graph.Graph, notify *graph.Notifier) (*graph.Graph, error)

WithNotify is plan, but with a notification feature

Types

type Result

type Result struct {
	Task   resource.Task
	Status resource.TaskStatus
	Err    error
}

Result is the result of planning execution

func (*Result) Changes

func (r *Result) Changes() map[string]resource.Diff

Changes returns the fields that will change based on this result

func (*Result) Error

func (r *Result) Error() error

Error returns the error assigned to this Result, if any

func (*Result) GetStatus

func (r *Result) GetStatus() resource.TaskStatus

GetStatus returns the current task status

func (*Result) GetTask

func (r *Result) GetTask() (resource.Task, bool)

GetTask returns the embedded task

func (*Result) HasChanges

func (r *Result) HasChanges() bool

HasChanges indicates if this result will change

func (*Result) Messages

func (r *Result) Messages() []string

Messages returns any message values supplied by the task

func (*Result) Warning

func (r *Result) Warning() string

Warning returns the warning assigned to this Result, if any