job

Documentation

Index

• Constants
• func NoOpHandlerFunc(ctx context.Context, et EventType, j *tork.Job) error
• type EventType
• type HandlerFunc
  • func ApplyMiddleware(h HandlerFunc, mws []MiddlewareFunc) HandlerFunc
  • func Webhook(next HandlerFunc) HandlerFunc
• type MiddlewareFunc
  • func Redact(redacter *redact.Redacter) MiddlewareFunc

Constants

const (
	// StateChange occurs when a job's state changes.
	// Handler can inspect the job's State property
	// in order to determine what state the job is at.
	StateChange = "STATE_CHANGE"
	// Progress occurs when a job's progress changes.
	Progress = "PROGRESS"
	// Read occurs when a Job is read by the client
	// through the API.
	Read = "READ"
)

Functions

func NoOpHandlerFunc

func NoOpHandlerFunc(ctx context.Context, et EventType, j *tork.Job) error

Types

type EventType

type EventType string

type HandlerFunc

type HandlerFunc func(ctx context.Context, et EventType, j *tork.Job) error

func ApplyMiddleware

func ApplyMiddleware(h HandlerFunc, mws []MiddlewareFunc) HandlerFunc

func Webhook

func Webhook(next HandlerFunc) HandlerFunc

type MiddlewareFunc

type MiddlewareFunc func(next HandlerFunc) HandlerFunc

func Redact

func Redact(redacter *redact.Redacter) MiddlewareFunc