proto

package
v0.5.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 20, 2026 License: GPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	ARGS_ENV             = "STANDARD_BACKUPS_ARGS"
	BACKUP_ID_ENV        = "STANDARD_BACKUPS_BACKUP_ID"
	COMMAND_ENV          = "STANDARD_BACKUPS_COMMAND"
	DESTINATION_NAME_ENV = "STANDARD_BACKUPS_DESTINATION_NAME"
	EXCLUDE_ENV          = "STANDARD_BACKUPS_EXCLUDE"
	JOB_NAME_ENV         = "STANDARD_BACKUPS_JOB_NAME"
	OPTIONS_ENV          = "STANDARD_BACKUPS_OPTIONS"
	OUTPUT_DIR_ENV       = "STANDARD_BACKUPS_OUTPUT_DIR"
	PATHS_ENV            = "STANDARD_BACKUPS_PATHS"
	VARIANT_NAME_ENV     = "STANDARD_BACKUPS_VARIANT_NAME"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type BackendClient

type BackendClient struct {
	Manifest config.BackendManifestV1
}

func NewBackendClient

func NewBackendClient(cfg config.Config, name string) (*BackendClient, error)

func (*BackendClient) Backup

func (bc *BackendClient) Backup(req *BackupRequest) error

func (*BackendClient) Exec

func (bc *BackendClient) Exec(req *ExecRequest) error

func (*BackendClient) ListBackups

func (bc *BackendClient) ListBackups(req *ListBackupsRequest) (*ListBackupsResponse, error)

func (*BackendClient) Restore

func (bc *BackendClient) Restore(req *RestoreRequest) error

type BackendImpl

type BackendImpl struct {
	Backup      BackupFunc
	Exec        ExecFunc
	ListBackups ListBackupsFunc
	Restore     RestoreFunc
}

func (*BackendImpl) Execute

func (bi *BackendImpl) Execute()

type BackupFunc

type BackupFunc func(req *BackupRequest) error

type BackupRequest

type BackupRequest struct {
	Paths           []string
	Exclude         []string
	DestinationName string
	VariantName     string
	JobName         string
	RawOptions      map[string]any
}

func NewBackupRequestFromEnv

func NewBackupRequestFromEnv() (*BackupRequest, error)

func (*BackupRequest) ToEnv

func (br *BackupRequest) ToEnv() ([]string, error)

type ExecFunc

type ExecFunc func(req *ExecRequest) error

type ExecRequest

type ExecRequest struct {
	Args            []string
	DestinationName string
	VariantName     string
	RawOptions      map[string]any
}

func NewExecRequestFromEnv

func NewExecRequestFromEnv() (*ExecRequest, error)

func (*ExecRequest) ToEnv

func (r *ExecRequest) ToEnv() ([]string, error)

type ListBackupsFunc

type ListBackupsFunc func(req *ListBackupsRequest) (*ListBackupsResponse, error)

type ListBackupsRequest

type ListBackupsRequest struct {
	RawOptions      map[string]any
	DestinationName string
	VariantName     string
}

func NewListBackupsRequestsFromEnv

func NewListBackupsRequestsFromEnv() (*ListBackupsRequest, error)

func (*ListBackupsRequest) ToEnv

func (lbr *ListBackupsRequest) ToEnv() ([]string, error)

type ListBackupsResponse

type ListBackupsResponse struct {
	Backups []ListBackupsResponseItem `json:"backups"`
}

type ListBackupsResponseItem

type ListBackupsResponseItem struct {
	Id          string         `json:"id"`
	Time        string         `json:"time"`
	Job         string         `json:"job"`
	Destination string         `json:"destination"`
	Variant     string         `json:"variant"`
	Size        int            `json:"size"` // Size of the backup in bytes
	Extra       map[string]any `json:"extra"`
}

type RestoreFunc

type RestoreFunc func(*RestoreRequest) error

type RestoreRequest

type RestoreRequest struct {
	RawOptions      map[string]any
	DestinationName string
	VariantName     string
	BackupId        string
	OutputDir       string
}

func NewRestoreRequestFromEnv

func NewRestoreRequestFromEnv() (*RestoreRequest, error)

func (*RestoreRequest) ToEnv

func (r *RestoreRequest) ToEnv() ([]string, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL