foldercleaner

README

go-foldercleaner

Scheduled deletion of folder content

Documentation

Index

• type CfgCleanerTask
• type Configuration
• type FolderCleaner
  • func GetFolderCleaner(logger *log.Entry, ctx context.Context, wg *sync.WaitGroup, ...) (*FolderCleaner, error)
  • func (fc FolderCleaner) IsAlive() (bool, string)
  • func (fc FolderCleaner) IsReady() (bool, string)
  • func (fc *FolderCleaner) Schedule() error
• type FolderCleanerTask
  • func GetFolderCleanerTask(logger *log.Entry, ctx context.Context, wg *sync.WaitGroup, ...) (*FolderCleanerTask, error)
  • func (fct FolderCleanerTask) IsAlive() (bool, string)
  • func (fct FolderCleanerTask) IsReady() (bool, string)
  • func (fct *FolderCleanerTask) Schedule() error

Types

type CfgCleanerTask

type CfgCleanerTask struct {
	Path      string              `yaml:"path"`
	Pattern   *customtypes.Regexp `yaml:"pattern,omitempty"`
	TTL       time.Duration       `yaml:"ttl"`
	Interval  time.Duration       `yaml:"interval,omitempty"`
	Recursive bool                `yaml:"recursive"`
}

type Configuration

type Configuration struct {
	Tasks []CfgCleanerTask `yaml:"tasks"`
}

type FolderCleaner

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

func GetFolderCleaner

func GetFolderCleaner(logger *log.Entry, ctx context.Context, wg *sync.WaitGroup, config *Configuration) (*FolderCleaner, error)

func (FolderCleaner) IsAlive

func (fc FolderCleaner) IsAlive() (bool, string)

func (FolderCleaner) IsReady

func (fc FolderCleaner) IsReady() (bool, string)

func (*FolderCleaner) Schedule

func (fc *FolderCleaner) Schedule() error

type FolderCleanerTask

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

func GetFolderCleanerTask

func GetFolderCleanerTask(logger *log.Entry, ctx context.Context, wg *sync.WaitGroup, config *CfgCleanerTask) (*FolderCleanerTask, error)

func (FolderCleanerTask) IsAlive

func (fct FolderCleanerTask) IsAlive() (bool, string)

func (FolderCleanerTask) IsReady

func (fct FolderCleanerTask) IsReady() (bool, string)

func (*FolderCleanerTask) Schedule

func (fct *FolderCleanerTask) Schedule() error