cleanup

Documentation

Overview

Package cleanup implements the API handlers for running data deletion jobs.

Index

• type Config
  • func (c *Config) BlobstoreConfig() *storage.Config
  • func (c *Config) DatabaseConfig() *database.Config
  • func (c *Config) ObservabilityExporterConfig() *observability.Config
  • func (c *Config) SecretManagerConfig() *secrets.Config
• type ExportServer
  • func NewExportServer(cfg *Config, env *serverenv.ServerEnv) (*ExportServer, error)
  • func (s *ExportServer) Routes(ctx context.Context) *mux.Router
• type ExposureServer
  • func NewExposureServer(cfg *Config, env *serverenv.ServerEnv) (*ExposureServer, error)
  • func (s *ExposureServer) Routes(ctx context.Context) *mux.Router

Types

type Config

type Config struct {
	Database              database.Config
	SecretManager         secrets.Config
	Storage               storage.Config
	ObservabilityExporter observability.Config

	Port    string        `env:"PORT, default=8080"`
	Timeout time.Duration `env:"CLEANUP_TIMEOUT, default=10m"`
	TTL     time.Duration `env:"CLEANUP_TTL, default=336h"`

	DebugOverrideCleanupMinDuration bool `env:"DEBUG_OVERRIDE_CLEANUP_MIN_DURATION, default=false"`
}

Config represents the configuration and associated environment variables for the cleanup components.

func (*Config) BlobstoreConfig

func (c *Config) BlobstoreConfig() *storage.Config

func (*Config) DatabaseConfig

func (c *Config) DatabaseConfig() *database.Config

func (*Config) ObservabilityExporterConfig

func (c *Config) ObservabilityExporterConfig() *observability.Config

func (*Config) SecretManagerConfig

func (c *Config) SecretManagerConfig() *secrets.Config

type ExportServer

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

func NewExportServer

func NewExportServer(cfg *Config, env *serverenv.ServerEnv) (*ExportServer, error)

NewExportServer creates a server that manages deletion of old export files that are no longer needed by clients for download.

func (*ExportServer) Routes

func (s *ExportServer) Routes(ctx context.Context) *mux.Router

Routes defines and returns the routes for the export server.

type ExposureServer

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

func NewExposureServer

func NewExposureServer(cfg *Config, env *serverenv.ServerEnv) (*ExposureServer, error)

NewExposureServer creates a http.Handler for deleting exposure keys from the database.

func (*ExposureServer) Routes

func (s *ExposureServer) Routes(ctx context.Context) *mux.Router

Routes defines and returns the routes for the export server.