Versions in this module Expand all Collapse all v2 v2.0.0 May 2, 2026 Changes in this version + const ConfigGroupID + const ExecutionGroupID + const FlowFileExt + const FlowFileTemplateExt + const ReservedEnvVarPrefix + const RetrievalGroupID + const TimeoutOverrideEnv + const TmpDirLabel + const UpdateGroupID + const ViewGroupID + const WildcardNamespace + const WildcardWorkspace + var DefaultVerbAliasGroup = map[Verb]string + var FlowFileExtRegex = regexp.MustCompile(fmt.Sprintf(`%s(\.yaml|\.yml)?$`, regexp.QuoteMeta(FlowFileExt))) + var FlowFileTemplateExtRegex = regexp.MustCompile(fmt.Sprintf(`%s(\.yaml|\.yml)?$`, regexp.QuoteMeta(FlowFileTemplateExt))) + func HasFlowFileExt(file string) bool + func HasFlowFileTemplateExt(file string) bool + func MustParseExecutableID(id string) (workspace, namespace, name string) + func NewExecutableID(workspace, namespace, name string) string + func SortedValidVerbs() []string + type Argument struct + Default string + EnvKey string + Flag string + OutputFile string + Pos *int + Required bool + Type ArgumentType + func (a *Argument) Set(value string) + func (a *Argument) Validate() error + func (a *Argument) ValidateValue() error + func (a *Argument) Value() string + type ArgumentList []Argument + func (al *ArgumentList) FlagType(name string) ArgumentType + func (al *ArgumentList) Flags() []string + func (al *ArgumentList) Validate() error + func (al *ArgumentList) ValidateValues() error + type ArgumentType string + const ArgumentTypeBool + const ArgumentTypeFloat + const ArgumentTypeInt + const ArgumentTypeString + type Artifact struct + AsTemplate bool + DstDir string + DstName string + If string + SrcDir string + SrcName string + type Directory string + func (e Directory) ExpandDirectory(wsPath, execPath, processTmpDir string, env map[string]string) (dir string, isTmpDir bool, err error) + type ExecExecutableType struct + Args ArgumentList + Cmd string + Dir Directory + File string + LogMode io.LogMode + Params ParameterList + func (e *ExecExecutableType) GetLogFields() map[string]interface{} + func (e *ExecExecutableType) SetLogFields(fields map[string]interface{}) + type Executable struct + Aliases ExecutableAliases + Annotations ExecutableAnnotations + Description string + Exec *ExecExecutableType + Launch *LaunchExecutableType + Name string + Parallel *ParallelExecutableType + Render *RenderExecutableType + Request *RequestExecutableType + Serial *SerialExecutableType + Tags ExecutableTags + Timeout *time.Duration + Verb Verb + VerbAliases []Verb + Visibility *ExecutableVisibility + func (e *Executable) AliasesIDs() []string + func (e *Executable) Env() *ExecutableEnvironment + func (e *Executable) FlowFilePath() string + func (e *Executable) ID() string + func (e *Executable) IsExecutableFromWorkspace(workspaceFilter string) bool + func (e *Executable) IsVisibleFromWorkspace(workspaceFilter string, visibilityFilter common.Visibility) bool + func (e *Executable) JSON() (string, error) + func (e *Executable) Markdown() string + func (e *Executable) MarshalJSON() ([]byte, error) + func (e *Executable) MergeTags(tags common.Tags) + func (e *Executable) NameEquals(name string) bool + func (e *Executable) Namespace() string + func (e *Executable) Ref() Ref + func (e *Executable) SetContext(workspaceName, workspacePath, namespace, flowFilePath string) + func (e *Executable) SetDefaults() + func (e *Executable) SetInheritedFields(flowFile *FlowFile) + func (e *Executable) UnmarshalJSON(data []byte) error + func (e *Executable) Validate() error + func (e *Executable) Workspace() string + func (e *Executable) WorkspacePath() string + func (e *Executable) YAML() (string, error) + type ExecutableAliases common.Aliases + type ExecutableAnnotations common.Annotations + type ExecutableEnvironment struct + Args ArgumentList + Params ParameterList + type ExecutableList []*Executable + func (l ExecutableList) FilterByAnnotations(selectors []string) ExecutableList + func (l ExecutableList) FilterByNamespace(ns string) ExecutableList + func (l ExecutableList) FilterBySubstring(str string) ExecutableList + func (l ExecutableList) FilterByTags(tags common.Tags) ExecutableList + func (l ExecutableList) FilterByVerb(verb Verb) ExecutableList + func (l ExecutableList) FilterByWorkspace(ws string) ExecutableList + func (l ExecutableList) FilterByWorkspaceWithVisibility(ws string, vis common.Visibility) ExecutableList + func (l ExecutableList) FindByVerbAndID(verb Verb, id string) (*Executable, error) + func (l ExecutableList) Items() []*types.EntityInfo + func (l ExecutableList) JSON() (string, error) + func (l ExecutableList) Plural() string + func (l ExecutableList) Singular() string + func (l ExecutableList) YAML() (string, error) + type ExecutableTags common.Tags + type ExecutableVisibility common.Visibility + type Field struct + Default string + Description string + Group int + Key string + Prompt string + Required bool + Type FieldType + Validate string + func (f *Field) Set(value string) + func (f *Field) ValidateConfig() error + func (f *Field) Value() string + type FieldType string + const FieldTypeConfirm + const FieldTypeMasked + const FieldTypeMultiline + const FieldTypeText + type FlowFile struct + Annotations FlowFileAnnotations + Description string + DescriptionFile string + Executables ExecutableList + Imports Imports + Namespace string + Tags []string + Visibility *FlowFileVisibility + func (f *FlowFile) ConfigPath() string + func (f *FlowFile) SetContext(workspaceName, workspacePath, configPath string) + func (f *FlowFile) SetDefaults() + func (f *FlowFile) WorkspacePath() string + func (f *FlowFile) YAML() (string, error) + type FlowFileAnnotations common.Annotations + type FlowFileList []*FlowFile + func (l *FlowFileList) FilterByNamespace(namespace string) FlowFileList + func (l *FlowFileList) FilterByTag(tag string) FlowFileList + type FlowFileVisibility common.Visibility + type FormFields []*Field + func (f FormFields) Set(key, value string) + func (f FormFields) Validate() error + func (f FormFields) ValueMap() map[string]string + type Imports []string + type LaunchExecutableType struct + App string + Args ArgumentList + Params ParameterList + URI string + type ParallelExecutableType struct + Args ArgumentList + Dir Directory + Execs ParallelRefConfigList + FailFast *bool + MaxThreads int + Params ParameterList + type ParallelRefConfig struct + Args []string + Cmd string + If string + Name string + Ref Ref + Retries int + type ParallelRefConfigList []ParallelRefConfig + type Parameter struct + EnvFile string + EnvKey string + OutputFile string + Prompt string + SecretRef string + Text string + func (p *Parameter) Validate() error + type ParameterList []Parameter + type Ref string + func NewRef(id string, verb Verb) Ref + func (r Ref) Equals(other Ref) bool + func (r Ref) ID() string + func (r Ref) Namespace() string + func (r Ref) String() string + func (r Ref) Verb() Verb + func (r Ref) Workspace() string + type RefList []Ref + type RenderExecutableType struct + Args ArgumentList + Dir Directory + Params ParameterList + TemplateDataFile string + TemplateFile string + type RequestExecutableType struct + Args ArgumentList + Body string + Headers RequestExecutableTypeHeaders + LogResponse bool + Method RequestExecutableTypeMethod + Params ParameterList + ResponseFile *RequestResponseFile + Timeout time.Duration + TransformResponse string + URL string + ValidStatusCodes []int + func (r *RequestExecutableType) MarshalJSON() ([]byte, error) + func (r *RequestExecutableType) UnmarshalJSON(data []byte) error + type RequestExecutableTypeHeaders map[string]string + type RequestExecutableTypeMethod string + const RequestExecutableTypeMethodDELETE + const RequestExecutableTypeMethodGET + const RequestExecutableTypeMethodPATCH + const RequestExecutableTypeMethodPOST + const RequestExecutableTypeMethodPUT + type RequestResponseFile struct + Dir Directory + Filename string + SaveAs RequestResponseFileSaveAs + type RequestResponseFileSaveAs string + const RequestResponseFileSaveAsIndentedJson + const RequestResponseFileSaveAsJson + const RequestResponseFileSaveAsRaw + const RequestResponseFileSaveAsYaml + const RequestResponseFileSaveAsYml + type SerialExecutableType struct + Args ArgumentList + Dir Directory + Execs SerialRefConfigList + FailFast *bool + Params ParameterList + type SerialRefConfig struct + Args []string + Cmd string + If string + Name string + Ref Ref + Retries int + ReviewRequired bool + type SerialRefConfigList []SerialRefConfig + type Template struct + Annotations TemplateAnnotations + Artifacts []Artifact + Form FormFields + PostRun []TemplateRefConfig + PreRun []TemplateRefConfig + Template string + func (t *Template) JSON() (string, error) + func (t *Template) Location() string + func (t *Template) Markdown() string + func (t *Template) Name() string + func (t *Template) SetContext(name, location string) + func (t *Template) Validate() error + func (t *Template) YAML() (string, error) + type TemplateAnnotations common.Annotations + type TemplateList []*Template + func (t TemplateList) Find(name string) *Template + func (t TemplateList) Items() []*types.EntityInfo + func (t TemplateList) JSON() (string, error) + func (t TemplateList) Plural() string + func (t TemplateList) Singular() string + func (t TemplateList) YAML() (string, error) + type TemplateRefConfig struct + Args []string + Cmd string + If string + Ref TemplateRefConfigRef + type TemplateRefConfigRef Ref + type Verb string + const VerbAbort + const VerbActivate + const VerbAdd + const VerbAnalyze + const VerbApply + const VerbArchive + const VerbAudit + const VerbBackup + const VerbBenchmark + const VerbBuild + const VerbBundle + const VerbCheck + const VerbClean + const VerbClear + const VerbCommit + const VerbCompile + const VerbCompress + const VerbConfigure + const VerbConnect + const VerbCopy + const VerbCreate + const VerbDeactivate + const VerbDebug + const VerbDecompress + const VerbDecrypt + const VerbDelete + const VerbDeploy + const VerbDestroy + const VerbDisable + const VerbDisconnect + const VerbEdit + const VerbEnable + const VerbEncrypt + const VerbErase + const VerbExec + const VerbExecute + const VerbExport + const VerbExpose + const VerbFetch + const VerbFix + const VerbFlush + const VerbFormat + const VerbGenerate + const VerbGet + const VerbImport + const VerbIndex + const VerbInit + const VerbInspect + const VerbInstall + const VerbJoin + const VerbKill + const VerbLaunch + const VerbLint + const VerbList + const VerbLoad + const VerbLock + const VerbLogin + const VerbLogout + const VerbManage + const VerbMerge + const VerbMigrate + const VerbModify + const VerbMonitor + const VerbMount + const VerbNew + const VerbNotify + const VerbOpen + const VerbPackage + const VerbPartition + const VerbPatch + const VerbPause + const VerbPing + const VerbPrefetch + const VerbPreload + const VerbProfile + const VerbProvision + const VerbPublish + const VerbPurge + const VerbPush + const VerbQueue + const VerbReboot + const VerbRecover + const VerbRefresh + const VerbRelease + const VerbReload + const VerbRemove + const VerbRequest + const VerbReset + const VerbRestart + const VerbRestore + const VerbRetrieve + const VerbRollback + const VerbRun + const VerbSave + const VerbScale + const VerbScan + const VerbSchedule + const VerbSeed + const VerbSend + const VerbServe + const VerbSet + const VerbSetup + const VerbShow + const VerbSnapshot + const VerbStart + const VerbStash + const VerbStop + const VerbTag + const VerbTeardown + const VerbTerminate + const VerbTest + const VerbTidy + const VerbTrace + const VerbTransform + const VerbTrigger + const VerbTunnel + const VerbUndeploy + const VerbUninstall + const VerbUnmount + const VerbUnset + const VerbUpdate + const VerbUpgrade + const VerbValidate + const VerbVerify + const VerbView + const VerbWatch + func RelatedVerbs(verb Verb) []Verb + func ValidVerbs() []Verb + func (v Verb) Equals(other Verb) bool + func (v Verb) String() string + func (v Verb) Validate() error Other modules containing this package github.com/flowexec/flow
Go to main page