# Functions
BuildTargetConfig is a helper function to build a target schema - short: the short name of the target - long: the long name of the target - target: the target type returns the target schema.
CreateAction creates a new action.
CreateJob creates a new job opts are the options to set on the job returns the job.
CreateLoopStack creates a new loop stack returns the loop stack.
CreateManifest creates a new manifest opts are the options to set on the manifest returns the manifest.
CreateMetaData creates a new metadata opts are the options to set on the metadata returns the metadata.
No description provided by the author
createWorkflow creates a new workflow - opts: the workflow options returns: the workflow.
OptionActionAction sets the action on the action.
OptionActionConfig sets the config on the action.
OptionActionContinueOnError sets the continue on error flag on the action.
OptionActionDescription sets the description on the action.
OptionActionDisabled sets the disabled flag on the action.
OptionActionFail sets the fail flag on the action.
OptionActionKey sets the key on the action.
OptionJobActions sets the actions on the job v is the actions as a slice of Action.
OptionJobDescription sets the description on the job v is the description.
OptionJobKey sets the key on the job v is the key.
OptionJobTitle sets the title on the job v is the title.
OptionManifestData sets the data on the manifest v is the data as a map[string]interface{}.
OptionManifestJobs sets the jobs on the manifest v is the slice of jobs.
OptionManifestMeta sets the meta data on the manifest v is the meta data.
OptionManifestParameters sets the parameters on the manifest v is the slice of parameters.
OptionMetaDataAuthor sets the author on the metadata v is the author.
OptionMetaDataContact sets the contact on the metadata v is the contact.
OptionMetaDataCreatedDate sets the created date on the metadata v is the created date.
OptionMetaDataDescription sets the description on the metadata v is the description.
OptionMetaDataName sets the name on the metadata v is the name.
OptionMetaDataUpdateDate sets the update date on the metadata v is the update date.
OptionMetaDataVars sets the vars on the metadata v is the vars.
OptionMetaDataVersion sets the version on the metadata v is the version.
OptionParameterDescription sets the description of the parameter - v is the description of the parameter.
OptionParameterKey sets the key of the parameter - v is the key of the parameter.
OptionParameterTitle sets the title of the parameter - v is the title of the parameter.
OptionParameterType sets the type of the parameter - v is the type of the parameter.
OptionParameterValue sets the value of the parameter - v is the value of the parameter.
OptionWorkflowLogLevel sets the LogLevel option 0 = quiet 1 = info 2 = LogLevel.
OptionWorkflowManifest sets the manifest option - v: the manifest.
# Constants
show Action messages.
just show print messages.
show Action messages and LogLevel messages.
Parameter data types.
Parameter data types.
Parameter data types.
Parameter data types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
ErrEndWorkflow is the error that is returned when the workflow is endedUse this error to end the workflow but not return an error to the caller.
# Structs
Action is the struct that defines an action.
ActionSchema is the schema definition for the action plugin.
No description provided by the author
No description provided by the author
No description provided by the author
Job is a workflow job.
Manifest is a workflow manifest and contains all the information needed to run a workflow.
MetaData is the metadata for a workflow.
Parameter is a struct that holds the information for a parameter.
Schema is the schema definition for the action plugin.
TargetSchema is the schema definition for the target plugin.
TemplateData is the data that is passed to the template engine.
Workflow is the main struct for the workflow.
# Interfaces
SchemaEndpoint is the interface that needs to be implemented by the plugin.
# Type aliases
ActionFunc is the function definition that needs to be implemented to be able to execute an action, this is called by the workflow - w: the workflow - m: the template data returns an error if the action fails.
ActionOption is a function that sets an option on the action.
DeleteConfigFunc is the function definition that needs to be implemented to be able to delete config values to the config store of choice - key: the key to delete - custom: the custom data that is used to to pass data to the config function.
EventFunc is the function definition is used as part of the workflow event system Start and a cleanup function can be added to the workflow and you implement code to handle the event - w: the workflow returns an error if the event fails.
InlineFormatter is used with the action schema to format the inline params inline params as passed with the action name e.g action "print;Hello World" Normally params are passed as a map[string]interface{} in the action config but if the action schema has InlineParams set to true then the params are passed as a string - cfg: the config map returns the formatted string.
JobOption is a function that sets an option on the job.
ManifestOption is a function that sets an option on the manifest.
MetaDataOption is a function that sets an option on the metadata.
ParameterOption is a function that sets a parameter option.
ReadConfigFunc is the function definition that needs to be implemented for when you want to get config values from the config store of choice - key: the key to get - data_type: the data type to convert the value to - custom: the custom data that is used to to pass data to the config function returns the value of the config or nil if the config does not exist returns an error.
TargetMapFunc is the function that is called to map config values to a target type - w: the workflow - m: the config values - target: the target type.
No description provided by the author
No description provided by the author
WorkflowOption is a function that sets a workflow option.
WriteConfigFunc is the function definition that needs to be implemented to be able to write config values to the config store of choice - key: the key to write - value: the value to write - custom: the custom data that is used to to pass data to the config function.