batch_job

Documentation

Index

• type BaseConfig
  • func (c *BaseConfig) ProcessingInterval() taskprocessor.ProcessingInterval
  • func (c *BaseConfig) Validate() error
• type BatchJob
  • func NewBatchJob(options ...BatchJobConfigOption) *BatchJob
  • func (c *BatchJob) String() string
  • func (c *BatchJob) Validate() error
• type BatchJobConfigOption
  • func WithBaseConfig(cfg BaseConfig) BatchJobConfigOption
  • func WithTask(task *asynq.Task) BatchJobConfigOption
  • func WithTaskId(taskId *string) BatchJobConfigOption
• type BatchJobs
  • func NewBatchJobs(options ...BatchJobsOption) *BatchJobs
  • func (b *BatchJobs) AddJob(job *BatchJob)
• type BatchJobsOption
  • func WithBatchJob(batchJob *BatchJob) BatchJobsOption
  • func WithBatchJobs(batchJobs *BatchJobs) BatchJobsOption
• type Batcher
  • func NewBatcher(options ...BatcherOption) *Batcher
  • func (b *Batcher) RegisterRecurringBatchJobs(ctx context.Context) error
• type BatcherOption
  • func WithBatchJobsRef(batchJobs *BatchJobs) BatcherOption
  • func WithTaskProcessor(processor *taskprocessor.TaskProcessor) BatcherOption
• type Runnable

Types

type BaseConfig

type BaseConfig struct {
	Enabled    bool   `json:"enabled"`
	Interval   string `json:"interval"` // e.g. "10s", "1m", "1h"
	MaxRetries int64  `json:"maxRetries"`
}

func (*BaseConfig) ProcessingInterval

func (c *BaseConfig) ProcessingInterval() taskprocessor.ProcessingInterval

func (*BaseConfig) Validate

func (c *BaseConfig) Validate() error

Validate checks the correctness of the base config values.

type BatchJob

type BatchJob struct {
	BaseConfig
	// contains filtered or unexported fields
}

func NewBatchJob

func NewBatchJob(options ...BatchJobConfigOption) *BatchJob

func (*BatchJob) String

func (c *BatchJob) String() string

func (*BatchJob) Validate

func (c *BatchJob) Validate() error

type BatchJobConfigOption

type BatchJobConfigOption func(*BatchJob)

func WithBaseConfig

func WithBaseConfig(cfg BaseConfig) BatchJobConfigOption

func WithTask

func WithTask(task *asynq.Task) BatchJobConfigOption

func WithTaskId

func WithTaskId(taskId *string) BatchJobConfigOption

type BatchJobs

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

func NewBatchJobs

func NewBatchJobs(options ...BatchJobsOption) *BatchJobs

func (*BatchJobs) AddJob

func (b *BatchJobs) AddJob(job *BatchJob)

AddJob appends a new BatchJob to the jobs slice.

type BatchJobsOption

type BatchJobsOption func(*BatchJobs)

func WithBatchJob

func WithBatchJob(batchJob *BatchJob) BatchJobsOption

WithBatchJobs sets the batch jobs for the batcher.

func WithBatchJobs

func WithBatchJobs(batchJobs *BatchJobs) BatchJobsOption

type Batcher

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

func NewBatcher

func NewBatcher(options ...BatcherOption) *Batcher

NewBatcher creates a new batcher.

func (*Batcher) RegisterRecurringBatchJobs

func (b *Batcher) RegisterRecurringBatchJobs(ctx context.Context) error

RegisterRecurringBatchJobs registers all recurring batch jobs.

type BatcherOption

type BatcherOption func(*Batcher)

func WithBatchJobsRef

func WithBatchJobsRef(batchJobs *BatchJobs) BatcherOption

WithBatchJobs sets the batch jobs for the batcher.

func WithTaskProcessor

func WithTaskProcessor(processor *taskprocessor.TaskProcessor) BatcherOption

WithTaskProcessor sets the task processor for the batcher.

type Runnable

type Runnable interface {
	RegisterRecurringBatchJobs(ctx context.Context) error
}

Runnable is an interface that defines a method to register recurring batch jobs.