purge

Documentation

Index

• Constants
• Variables
• func String(extras map[string]interface{}) string
• type Controller
  • func NewController() Controller
• type JobPolicy
• type Trigger
• type TriggerSettings
• type TriggerType

Constants

const (
	// SchedulerCallback ...
	SchedulerCallback = "PURGE_AUDIT_LOG_CALLBACK"
)

Variables

var Ctrl = NewController()

Ctrl a global purge controller instance

Functions

func String

func String(extras map[string]interface{}) string

String convert map to json string

Types

type Controller

type Controller interface {
	// Start kick off a purge schedule
	Start(ctx context.Context, policy JobPolicy, trigger string) (int64, error)
	// Stop a purge job
	Stop(ctx context.Context, id int64) error
}

Controller defines the interface with the purge job

func NewController

func NewController() Controller

NewController ...

type JobPolicy

type JobPolicy struct {
	Trigger           *Trigger               `json:"trigger"`
	DryRun            bool                   `json:"dryrun"`
	RetentionHour     int                    `json:"retention_hour"`
	IncludeOperations string                 `json:"include_operations"`
	ExtraAttrs        map[string]interface{} `json:"extra_attrs"`
}

JobPolicy defines the purge job policy

type Trigger

type Trigger struct {
	Type     TriggerType      `json:"type"`
	Settings *TriggerSettings `json:"trigger_settings"`
}

Trigger holds info for a trigger

type TriggerSettings

type TriggerSettings struct {
	Cron string `json:"cron"`
}

TriggerSettings is the setting about the trigger

type TriggerType

type TriggerType string

TriggerType represents the type of trigger.