blueprint

Documentation

Index

• Constants
• Variables
• func PreValidate(sp *Blueprint) error
• func TestMinCliVersion(bp *Blueprint) error
• type ActionValidatorFunc
• type Blueprint
  • func NewFromBackend(bpUrl *BlueprintURL) (*Blueprint, error)
  • func NewFromBuilder(data []byte) (*Blueprint, error)
  • func NewFromBytes(data []byte) (*Blueprint, error)
  • func NewFromFile(bpUrl *BlueprintURL) (*Blueprint, error)
  • func NewFromMarket(bpUrl *BlueprintURL) (*Blueprint, error)
• type BlueprintURL
  • func ParsePath(path string) (*BlueprintURL, error)
  • func ParseURL(path string) (*BlueprintURL, error)
• type ConditionalNextActions
• type IRBArg
  • func ParseBPArgs(args []string) ([]*IRBArg, error)
• type IRBError
• type IRBErrors
  • func (ies IRBErrors) Error() string
• type IRBGenConfig
• type IRBlueprint
  • func GenerateIRB(bp *Blueprint, irbConf *IRBGenConfig) (*IRBlueprint, error)
  • func NewIRBFromAny(bpurl *BlueprintURL, irbConf *IRBGenConfig) (*IRBlueprint, error)
• type InternalParameters

Constants

const DebugActionName = "debug"

const JoinThreadsActionName = "join_threads"

JoinThreadsActionName const

Variables

var ActionValidators map[string]ActionValidatorFunc = make(map[string]ActionValidatorFunc)

Functions

func PreValidate

func PreValidate(sp *Blueprint) error

PreValidate func

func TestMinCliVersion

func TestMinCliVersion(bp *Blueprint) error

Types

type ActionValidatorFunc

type ActionValidatorFunc func(action *base.Action) error

ActionValidatorFunc type

type Blueprint

type Blueprint struct {
	ExecutionUUID   *string
	Actions         []base.Action `json:"actions"`
	MinCLIVersion   *string       `json:"min_cli_version"`
	Raw             *[]byte
	BuilderErrors   int `json:"n_errors"`
	BuilderWarnings int `json:"n_warnings"`
}

Blueprint struct

func NewFromBackend

func NewFromBackend(bpUrl *BlueprintURL) (*Blueprint, error)

NewFromBackend func

func NewFromBuilder

func NewFromBuilder(data []byte) (*Blueprint, error)

NewFromBuilder func

func NewFromBytes

func NewFromBytes(data []byte) (*Blueprint, error)

NewFromBytes func

func NewFromFile

func NewFromFile(bpUrl *BlueprintURL) (*Blueprint, error)

NewFromFile func

func NewFromMarket

func NewFromMarket(bpUrl *BlueprintURL) (*Blueprint, error)

type BlueprintURL

type BlueprintURL struct {
	Scheme           string
	OrganizationSlug string
	CollectionSlug   string
	BlueprintSlug    string
	Version          string
	FilePath         string
	UrlPath          string
}

func ParsePath

func ParsePath(path string) (*BlueprintURL, error)

func ParseURL

func ParseURL(path string) (*BlueprintURL, error)

type ConditionalNextActions

type ConditionalNextActions struct {
	True  []string `json:"true"`
	False []string `json:"false"`
}

type IRBArg

type IRBArg struct {
	Name  string
	Value string
}

IRBArg struct. Represent parsed blueprint cli args

func ParseBPArgs

func ParseBPArgs(args []string) ([]*IRBArg, error)

type IRBError

type IRBError interface {
	// String representation, needed for error interface
	Error() string
	// ActionID if exists, empty string if not
	ActionID() string
	// The raw wrapped error
	WErr() error
}

type IRBErrors

type IRBErrors []IRBError

func (IRBErrors) Error

func (ies IRBErrors) Error() string

type IRBGenConfig

type IRBGenConfig struct {
	AllowResultReturn bool
	Args              []string
}

IRBGenConfig struct

type IRBlueprint

type IRBlueprint struct {
	BP            *Blueprint
	ExecutionUUID *string
	// [thread-action-id][thread-path]*base.Action
	JoinThreadPoints map[string]*base.Action
	Actions          map[string]*base.Action
	StartAction      *base.Action
	Args             []*IRBArg
}

IRBlueprint struct. Intermediate Representation Blueprint. Precompiler.

func GenerateIRB

func GenerateIRB(bp *Blueprint, irbConf *IRBGenConfig) (*IRBlueprint, error)

GenerateIRB func

func NewIRBFromAny

func NewIRBFromAny(bpurl *BlueprintURL, irbConf *IRBGenConfig) (*IRBlueprint, error)

type InternalParameters

type InternalParameters struct {
	Waiters []string `json:"_waiters"`
}

InternalParameters struct Config params defined to be used internally.