entrypoint

Documentation

Overview

Entrypoint manage pipeline's definitions to get Pipeline ready to be used by the core

Index

• Constants
• type Entrypoint
  • func New(contentValue string, cwl string, contentKind int) (*Entrypoint, error)
  • func (e *Entrypoint) Pipeline() (*core.Pipeline, error)
• type EntrypointList
  • func (e *EntrypointList) AddEntrypoint(loc *Entrypoint) error

Constants

const (
	CONTENT_REF     = iota // Content is a reference to something
	CONTENT_REF_FS         // Content is a reference to something on the filesystem
	CONTENT_REF_URL        // Content is a reference to something on the web (http, https)
	CONTENT_INLINE         // Content is a value
)

Types

type Entrypoint

type Entrypoint struct {
	FullPath     string
	Path         string
	Kind         int // Kind of content
	Workingpath  string
	Content      string
	PipelineName string
	PipelineUuid string
}

Entrypoint is a the pipeline's definition ressource

func New

func New(contentValue string, cwl string, contentKind int) (*Entrypoint, error)

Create a new entrypoint (pipeline definition)

- contentValue may be a filesystem path, a URL or a string,

- cwl Working Location should be provided to the parser, it could be an filesystem dir, a baseUrl base path, this part is used when the entrypoint contains references to other configurations. @see use, route processors.

- contentKind refer to the kind of contentValue @see CONTENT_* constants

func (*Entrypoint) Pipeline

func (e *Entrypoint) Pipeline() (*core.Pipeline, error)

type EntrypointList

type EntrypointList struct {
	Items []*Entrypoint
}

List of Entrypoints

func (*EntrypointList) AddEntrypoint

func (e *EntrypointList) AddEntrypoint(loc *Entrypoint) error

AddEntrypoint add the provided entrypoint to the list