Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

executor

package

Go to main page

Versions in this module

v1

v1.2.11

Aug 28, 2026

Changes in this version

type ExecuteTask

+ DispatchID string

v1.2.10-alpha

Aug 28, 2026

v1.2.9

Aug 27, 2026

v1.2.8

Aug 24, 2026

Changes in this version

+ var ErrAlreadyRegistered = errors.New("executor already registered")

+ var ErrLocalFuncAlreadyRegistered = errors.New("local function already registered")

+ var ErrNotImplemented = errors.New("executor not implemented")

+ func ClassifyFailure(err error) (retryable bool, retryAfter time.Duration, classified bool)

+ func PermanentFailure(err error) error

+ func RetryableFailure(err error, retryAfter time.Duration) error

+ type AsyncExecutor interface

+ Cancel func(ctx context.Context, task ExecuteTask, externalTaskID string) error

+ Poll func(ctx context.Context, task ExecuteTask, externalTaskID string) (ExecuteResult, error)

+ type ContainerExecutor struct

+ func (e *ContainerExecutor) Cancel(context.Context, Request, string) error

+ func (e *ContainerExecutor) Execute(ctx context.Context, task Request) (Result, error)

+ func (e *ContainerExecutor) Poll(context.Context, Request, string) (Result, error)

+ func (e *ContainerExecutor) Type() Type

+ type Dispatcher interface

+ Dispatch func(task ExecuteTask) (Executor, error)

+ type ExecuteResult struct

+ DeleteVariables []string

+ Error string

+ ExternalTaskID string

+ FinishedAt time.Time

+ Logs []string

+ Metadata map[string]any

+ Output any

+ RetryAfter time.Duration

+ Status Status

+ Variables map[string]any

+ func (r ExecuteResult) NormalizedStatus() Status

+ type ExecuteTask struct

+ Async bool

+ Attempt int

+ Context map[string]any

+ CredentialScope string

+ Deadline time.Time

+ ExecutorRef string

+ ExecutorType string

+ HeartbeatFreq time.Duration

+ Input any

+ MaxAttempts int

+ NodeID string

+ Params map[string]any

+ PollInterval time.Duration

+ RunID string

+ Timeout time.Duration

+ func (t ExecuteTask) Validate() error

+ type ExecutionFailure struct

+ Err error

+ Retry bool

+ RetryAfter time.Duration

+ func (e *ExecutionFailure) Error() string

+ func (e *ExecutionFailure) Unwrap() error

+ type Executor interface

+ Execute func(ctx context.Context, task ExecuteTask) (ExecuteResult, error)

+ Type func() Type

+ type HTTPExecutor struct

+ func NewHTTPExecutor(client *http.Client) *HTTPExecutor

+ func (e *HTTPExecutor) Execute(ctx context.Context, req Request) (Result, error)

+ func (e *HTTPExecutor) Type() Type

+ type InMemoryQueueBroker struct

+ func NewInMemoryQueueBroker() *InMemoryQueueBroker

+ func (b *InMemoryQueueBroker) Ack(_ context.Context, ticket string, result ExecuteResult) error

+ func (b *InMemoryQueueBroker) Cancel(_ context.Context, ticket string) error

+ func (b *InMemoryQueueBroker) Dequeue(ctx context.Context, queue string, wait time.Duration) (*QueuedTask, error)

+ func (b *InMemoryQueueBroker) Enqueue(ctx context.Context, queue string, task ExecuteTask) (string, error)

+ func (b *InMemoryQueueBroker) Poll(_ context.Context, ticket string) (ExecuteResult, error)

+ type LocalExecutor struct

+ func NewLocalExecutor() *LocalExecutor

+ func (e *LocalExecutor) Execute(ctx context.Context, req Request) (Result, error)

+ func (e *LocalExecutor) Register(name string, fn LocalFunc) error

+ func (e *LocalExecutor) RegisterOrReplace(name string, fn LocalFunc) error

+ func (e *LocalExecutor) Type() Type

+ type LocalFunc func(ctx context.Context, req Request) (Result, error)

+ type NodeExecutor struct

+ func (e *NodeExecutor) Execute(context.Context, Request) (Result, error)

+ func (e *NodeExecutor) Type() Type

+ type PythonExecutor struct

+ func (e *PythonExecutor) Execute(context.Context, Request) (Result, error)

+ func (e *PythonExecutor) Type() Type

+ type QueueBroker interface

+ Ack func(ctx context.Context, ticket string, result ExecuteResult) error

+ Cancel func(ctx context.Context, ticket string) error

+ Dequeue func(ctx context.Context, queue string, wait time.Duration) (*QueuedTask, error)

+ Enqueue func(ctx context.Context, queue string, task ExecuteTask) (string, error)

+ Poll func(ctx context.Context, ticket string) (ExecuteResult, error)

+ type QueueExecutor struct

+ Broker QueueBroker

+ func NewQueueExecutor(broker QueueBroker) *QueueExecutor

+ func (e *QueueExecutor) Cancel(ctx context.Context, task ExecuteTask, externalTaskID string) error

+ func (e *QueueExecutor) Execute(ctx context.Context, task ExecuteTask) (ExecuteResult, error)

+ func (e *QueueExecutor) Poll(ctx context.Context, task ExecuteTask, externalTaskID string) (ExecuteResult, error)

+ func (e *QueueExecutor) Type() Type

+ type QueuedTask struct

+ Queue string

+ Task ExecuteTask

+ Ticket string

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) Get(t Type) (Executor, bool)

+ func (r *Registry) MustRegister(exec Executor)

+ func (r *Registry) Register(exec Executor) error

+ func (r *Registry) RegisterAll(executors ...Executor) error

+ func (r *Registry) RegisterOrReplace(exec Executor) error

+ func (r *Registry) Types() []Type

+ type RegistryDispatcher struct

+ Registry *Registry

+ func NewRegistryDispatcher(reg *Registry) *RegistryDispatcher

+ func (d *RegistryDispatcher) Dispatch(task ExecuteTask) (Executor, error)

+ type RemoteExecutor struct

+ func (e *RemoteExecutor) Cancel(context.Context, Request, string) error

+ func (e *RemoteExecutor) Execute(ctx context.Context, task Request) (Result, error)

+ func (e *RemoteExecutor) Poll(context.Context, Request, string) (Result, error)

+ func (e *RemoteExecutor) Type() Type

+ type Request = ExecuteTask

+ type Result = ExecuteResult

+ type ScriptExecutor struct

+ func NewScriptExecutor() *ScriptExecutor

+ func (e *ScriptExecutor) Execute(ctx context.Context, task ExecuteTask) (ExecuteResult, error)

+ func (e *ScriptExecutor) Type() Type

+ type Status string

+ const StatusAccepted

+ const StatusFailed

+ const StatusRetryable

+ const StatusRunning

+ const StatusSucceeded

+ type Type string

+ const TypeContainer

+ const TypeHTTP

+ const TypeLocalGo

+ const TypeNodeJS

+ const TypePython

+ const TypeQueue

+ const TypeRemote

+ const TypeScript

+ const TypeUnit

v1.0.1-beta

Aug 21, 2026