resources

Documentation

Index

• func ExecutorYaml(filename string) (string, string)
• func NotEmpty(s string) bool
• func ParseYaml(cfg *types.JobConfig, file *os.File) bool
• func ReadFile(filename string) *os.File
• func ReadFileBytes(name string) []byte
• func SchedulerYaml(filename string) string
• func UnmarsharlYaml(byteArray []byte) types.EngineConfig

Functions

func ExecutorYaml

func ExecutorYaml(filename string) (string, string)

ExecutorYaml is used to return the yaml attribute needed for the executor endpoint parameters: filename (a string containing a file to read) returns: string, string (the job language and file if successful, a failure message if otherwise)

func NotEmpty

func NotEmpty(s string) bool

NotEmpty is used to check if a string is not empty parameters: s (a string to check) returns: boolean (true if not empty, false if otherwise)

func ParseYaml

func ParseYaml(cfg *types.JobConfig, file *os.File) bool

ParseYaml is used to parse a given YAML config parameters: cfg (a *Config to be decoded into), file, (am *os.File to build the decoder on) returns: boolean (true if parseable, false if otherwise)

func ReadFile

func ReadFile(filename string) *os.File

ReadFile is used to read a file and return it's contents parameters: filename (a string of the path to the file) returns: *os.File (the file descriptor)

func ReadFileBytes

func ReadFileBytes(name string) []byte

ReadFileBytes is used to read a file parameters: name (a string containing the path to a file) returns: []byte (an array of bytes containing the contents of the file)

func SchedulerYaml

func SchedulerYaml(filename string) string

SchedulerYaml is used to return the yaml attribute needed for the scheduler endpoint parameters: filename (a string containing a file to read) returns: string (the job schedule if successfully parsed, a failure message if otherwise)

func UnmarsharlYaml

func UnmarsharlYaml(byteArray []byte) types.EngineConfig

UnmarsharlYaml is used to unmarshal YAML parameters: byteArray (an array of bytes representing the contents of a file) returns: Config (a struct form of the YAML)