housekeeping

Documentation

Overview

Package housekeeping is the package for housekeeping service. It cleans up the resources and data that is no longer needed.

Index

• type Config
  • func (c *Config) ParseInterval() (time.Duration, error)
  • func (c *Config) Validate() error
• type Housekeeping
  • func New(conf *Config) (*Housekeeping, error)
  • func (h *Housekeeping) RegisterTask(interval time.Duration, task func(ctx context.Context) error) error
  • func (h *Housekeeping) Start() error
  • func (h *Housekeeping) Stop() error

Types

type Config

type Config struct {
	// Interval is the time between housekeeping runs.
	Interval string `yaml:"Interval"`

	// CandidatesLimitPerProject is the maximum number of candidates to be returned per project.
	CandidatesLimitPerProject int `yaml:"CandidatesLimitPerProject"`

	// ProjectFetchSize is the maximum number of projects to be returned to deactivate candidates.
	ProjectFetchSize int `yaml:"HousekeepingProjectFetchSize"`
}

Config is the configuration for the housekeeping service.

func (*Config) ParseInterval

func (c *Config) ParseInterval() (time.Duration, error)

ParseInterval parses the interval.

func (*Config) Validate

func (c *Config) Validate() error

Validate validates the configuration.

type Housekeeping

type Housekeeping struct {
	Config *Config
	// contains filtered or unexported fields
}

Housekeeping is the housekeeping service. It periodically runs housekeeping tasks.

func New

func New(conf *Config) (*Housekeeping, error)

New creates a new housekeeping instance.

func (*Housekeeping) RegisterTask

func (h *Housekeeping) RegisterTask(
	interval time.Duration,
	task func(ctx context.Context) error,
) error

RegisterTask registers task the housekeeping service.

func (*Housekeeping) Start

func (h *Housekeeping) Start() error

Start starts the housekeeping service.

func (*Housekeeping) Stop

func (h *Housekeeping) Stop() error

Stop stops the housekeeping service.