worker

Documentation

Index

• type BatchOptions
  • func (b *BatchOptions) GetConfirmationMessage(operation string, value any, input any) (string, error)
  • func (b *BatchOptions) GetItem() (string, error)
• type GenericWorker
  • func NewGenericWorker(log *logger.Logger, cfg *config.Config, iostream *iostreams.IOStreams, ...) (*GenericWorker, error)
  • func (w *GenericWorker) GetBatchOptions(cmd *cobra.Command) (*BatchOptions, error)
  • func (w *GenericWorker) GetMaxJobs() int64
  • func (w *GenericWorker) GetMaxWorkers() int
  • func (w *GenericWorker) Run(cmd *cobra.Command, iter iterator.Iterator, ...) error
  • func (w *GenericWorker) RunSequentially(cmd *cobra.Command, iter iterator.Iterator, ...) error
  • func (w *GenericWorker) StartWorker(id int, jobs <-chan Job, results chan<- error, prog *progressbar.ProgressBar, ...)
• type Job
• type RequestHandler
• type Runner
• type Worker
  • func NewWorker(log *logger.Logger, cfg *config.Config, iostream *iostreams.IOStreams, ...) (*Worker, error)
  • func (w *Worker) GetMaxJobs() int64
  • func (w *Worker) GetMaxWorkers() int
  • func (w *Worker) ProcessRequestAndResponse(cmd *cobra.Command, r *c8y.RequestOptions, ...) error

Types

type BatchOptions

type BatchOptions struct {
	StartIndex        int
	NumJobs           int
	TotalWorkers      int
	Delay             time.Duration
	DelayBefore       time.Duration
	AbortOnErrorCount int
	SemanticMethod    string

	PostActions []flags.Action

	InputData []string

	// Generic values
	ConfirmationMessage func(string, any, any) (string, error)
	// contains filtered or unexported fields
}

func (*BatchOptions) GetConfirmationMessage

func (b *BatchOptions) GetConfirmationMessage(operation string, value any, input any) (string, error)

func (*BatchOptions) GetItem

func (b *BatchOptions) GetItem() (string, error)

type GenericWorker

type GenericWorker struct {
	Config         *config.Config
	IO             *iostreams.IOStreams
	Logger         *logger.Logger
	Client         *c8y.Client
	ActivityLogger *activitylogger.ActivityLogger
	CheckError     func(error) error
	Execute        Runner
}

func NewGenericWorker

func NewGenericWorker(log *logger.Logger, cfg *config.Config, iostream *iostreams.IOStreams, client *c8y.Client, activityLog *activitylogger.ActivityLogger, runFunc Runner, checkError func(error) error) (*GenericWorker, error)

func (*GenericWorker) GetBatchOptions

func (w *GenericWorker) GetBatchOptions(cmd *cobra.Command) (*BatchOptions, error)

func (*GenericWorker) GetMaxJobs

func (w *GenericWorker) GetMaxJobs() int64

GetMaxJob maximum number of jobs allowed

func (*GenericWorker) GetMaxWorkers

func (w *GenericWorker) GetMaxWorkers() int

GetMaxWorkers maximum number of workers

func (*GenericWorker) Run

func (w *GenericWorker) Run(cmd *cobra.Command, iter iterator.Iterator, inputIterators *flags.RequestInputIterators) error

func (*GenericWorker) RunSequentially

func (w *GenericWorker) RunSequentially(cmd *cobra.Command, iter iterator.Iterator, inputIterators *flags.RequestInputIterators) error

func (*GenericWorker) StartWorker

func (w *GenericWorker) StartWorker(id int, jobs <-chan Job, results chan<- error, prog *progressbar.ProgressBar, wg *sync.WaitGroup)

These workers will receive work on the `jobs` channel and send the corresponding results on `results`

type Job

type Job struct {
	ID            int64
	Value         any
	CommonOptions config.CommonCommandOptions
	Input         any
	Options       BatchOptions
}

type RequestHandler

type RequestHandler func(requests []c8y.RequestOptions, input any, commonOptions config.CommonCommandOptions) (*c8y.Response, error)

type Runner

type Runner func(Job) (any, error)

type Worker

type Worker struct {
	// contains filtered or unexported fields
}

func NewWorker

func NewWorker(log *logger.Logger, cfg *config.Config, iostream *iostreams.IOStreams, client *c8y.Client, activityLog *activitylogger.ActivityLogger, reqHandlerFunc RequestHandler, checkError func(error) error) (*Worker, error)

func (*Worker) GetMaxJobs

func (w *Worker) GetMaxJobs() int64

GetMaxJob maximum number of jobs allowed

func (*Worker) GetMaxWorkers

func (w *Worker) GetMaxWorkers() int

GetMaxWorkers maximum number of workers

func (*Worker) ProcessRequestAndResponse

func (w *Worker) ProcessRequestAndResponse(cmd *cobra.Command, r *c8y.RequestOptions, inputIterators *flags.RequestInputIterators) error