config

type BackupSection struct {
	SectionWithScheduleAndMonitoring `mapstructure:",squash"`
	RunShellCommandsSection          `mapstructure:",squash"`

	CheckBefore       bool     `mapstructure:"check-before" description:"Check the repository before starting the backup command"`
	CheckAfter        bool     `mapstructure:"check-after" description:"Check the repository after the backup command succeeded"`
	UseStdin          bool     `mapstructure:"stdin" argument:"stdin"`
	StdinCommand      []string `` /* 175-byte string literal not displayed */
	SourceBase        string   `` /* 207-byte string literal not displayed */
	Source            []string `mapstructure:"source" examples:"/opt/;/home/user/;C:\\Users\\User\\Documents" description:"The paths to backup"`
	Exclude           []string `mapstructure:"exclude" argument:"exclude" argument-type:"no-glob"`
	Iexclude          []string `mapstructure:"iexclude" argument:"iexclude" argument-type:"no-glob"`
	ExcludeFile       []string `mapstructure:"exclude-file" argument:"exclude-file"`
	IexcludeFile      []string `mapstructure:"iexclude-file" argument:"iexclude-file"`
	FilesFrom         []string `mapstructure:"files-from" argument:"files-from"`
	FilesFromRaw      []string `mapstructure:"files-from-raw" argument:"files-from-raw"`
	FilesFromVerbatim []string `mapstructure:"files-from-verbatim" argument:"files-from-verbatim"`
	ExtendedStatus    bool     `mapstructure:"extended-status" argument:"json"`
	NoErrorOnWarning  bool     `mapstructure:"no-error-on-warning" description:"Do not fail the backup when some files could not be read"`
	// contains filtered or unexported fields
}

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

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

type CopySection struct {
	SectionWithScheduleAndMonitoring `mapstructure:",squash"`
	RunShellCommandsSection          `mapstructure:",squash"`
	Initialize                       bool              `mapstructure:"initialize" description:"Initialize the secondary repository if missing"`
	InitializeCopyChunkerParams      maybe.Bool        `` /* 141-byte string literal not displayed */
	Repository                       ConfidentialValue `mapstructure:"repository" description:"Destination repository to copy snapshots to"`
	RepositoryFile                   string            `mapstructure:"repository-file" description:"File from which to read the destination repository location to copy snapshots to"`
	PasswordFile                     string            `mapstructure:"password-file" description:"File to read the destination repository password from"`
	PasswordCommand                  string            `mapstructure:"password-command" description:"Shell command to obtain the destination repository password from"`
	KeyHint                          string            `mapstructure:"key-hint" description:"Key ID of key to try decrypting the destination repository first"`
	Snapshots                        []string          `mapstructure:"snapshot" description:"Snapshot IDs to copy (if empty, all snapshots are copied)"`
}

type DecoderFunc func(reader io.ReadSeeker) transform.Transformer

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

type Empty interface {
	IsEmpty() bool
}

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

type GenericSection struct {
	OtherFlagsSection       `mapstructure:",squash"`
	RunShellCommandsSection `mapstructure:",squash"`
}

type Global struct {
	IONice               bool          `` /* 161-byte string literal not displayed */
	IONiceClass          int           `` /* 134-byte string literal not displayed */
	IONiceLevel          int           `` /* 134-byte string literal not displayed */
	Nice                 int           `` /* 141-byte string literal not displayed */
	Priority             string        `` /* 179-byte string literal not displayed */
	DefaultCommand       string        `` /* 137-byte string literal not displayed */
	Initialize           bool          `mapstructure:"initialize" default:"false" description:"Initialize a repository if missing"`
	ResticBinary         string        `mapstructure:"restic-binary" description:"Full path of the restic executable (detected if not set)"`
	ResticVersion        string        // not configurable at the moment. To be set after ResticBinary is known.
	FilterResticFlags    bool          `` /* 138-byte string literal not displayed */
	ResticLockRetryAfter time.Duration `` /* 197-byte string literal not displayed */
	ResticStaleLockAge   time.Duration `` /* 237-byte string literal not displayed */
	ShellBinary          []string      `` /* 152-byte string literal not displayed */
	MinMemory            uint64        `` /* 184-byte string literal not displayed */
	Scheduler            string        `` /* 139-byte string literal not displayed */
	Log                  string        `` /* 208-byte string literal not displayed */
	LegacyArguments      bool          `` /* 148-byte string literal not displayed */
	SystemdUnitTemplate  string        `` /* 194-byte string literal not displayed */
	SystemdTimerTemplate string        `` /* 196-byte string literal not displayed */
	SenderTimeout        time.Duration `` /* 204-byte string literal not displayed */
	CACertificates       []string      `` /* 240-byte string literal not displayed */
	PreventSleep         bool          `` /* 190-byte string literal not displayed */
	GroupContinueOnError bool          `` /* 160-byte string literal not displayed */
}

type Group struct {
	Description     string     `mapstructure:"description" description:"Describe the group"`
	Profiles        []string   `mapstructure:"profiles" description:"Names of the profiles belonging to this group"`
	ContinueOnError maybe.Bool `` /* 151-byte string literal not displayed */
}

type InitSection struct {
	OtherFlagsSection   `mapstructure:",squash"`
	CopyChunkerParams   bool              `mapstructure:"copy-chunker-params" argument:"copy-chunker-params"`
	FromKeyHint         string            `mapstructure:"from-key-hint" argument:"from-key-hint"`
	FromRepository      ConfidentialValue `mapstructure:"from-repository" argument:"from-repo"`
	FromRepositoryFile  string            `mapstructure:"from-repository-file" argument:"from-repository-file"`
	FromPasswordFile    string            `mapstructure:"from-password-file" argument:"from-password-file"`
	FromPasswordCommand string            `mapstructure:"from-password-command" argument:"from-password-command"`
}

type Monitoring interface {
	GetSendMonitoring() *SendMonitoringSections
}

type Named interface {
	// Name provides the name of the item
	Name() string
	// Description provides a possibly empty description of the item
	Description() string
}

type NamedPropertySet interface {
	Named
	PropertySet
}

type NumericRange struct {
	From, To                   *float64
	FromExclusive, ToExclusive bool
}

type OtherFlags interface {
	GetOtherFlags() map[string]any
}

type OtherFlagsSection struct {
	OtherFlags map[string]any `mapstructure:",remain"`
}

type Profile struct {
	RunShellCommandsSection `mapstructure:",squash"`
	OtherFlagsSection       `mapstructure:",squash"`

	Name                 string
	Description          string                            `mapstructure:"description" description:"Describes the profile"`
	BaseDir              string                            `` /* 199-byte string literal not displayed */
	Quiet                bool                              `mapstructure:"quiet" argument:"quiet"`
	Verbose              int                               `mapstructure:"verbose" argument:"verbose"`
	KeyHint              string                            `mapstructure:"key-hint" argument:"key-hint"`
	Repository           ConfidentialValue                 `mapstructure:"repository" argument:"repo"`
	RepositoryFile       string                            `mapstructure:"repository-file" argument:"repository-file"`
	PasswordFile         string                            `mapstructure:"password-file" argument:"password-file"`
	PasswordCommand      string                            `mapstructure:"password-command" argument:"password-command"`
	CacheDir             string                            `mapstructure:"cache-dir" argument:"cache-dir"`
	CACert               string                            `mapstructure:"cacert" argument:"cacert"`
	TLSClientCert        string                            `mapstructure:"tls-client-cert" argument:"tls-client-cert"`
	Initialize           bool                              `mapstructure:"initialize" default:"" description:"Initialize the restic repository if missing"`
	Inherit              string                            `mapstructure:"inherit" show:"noshow" description:"Name of the profile to inherit all of the settings from"`
	Lock                 string                            `mapstructure:"lock" description:"Path to the lock file to use with resticprofile locks"`
	ForceLock            bool                              `mapstructure:"force-inactive-lock" description:"Allows to lock when the existing lock is considered stale"`
	StreamError          []StreamErrorSection              `mapstructure:"stream-error" description:"Run shell command(s) when a pattern matches the stderr of restic"`
	StatusFile           string                            `mapstructure:"status-file" description:"Path to the status file to update with a summary of last restic command result"`
	PrometheusSaveToFile string                            `` /* 147-byte string literal not displayed */
	PrometheusPush       string                            `` /* 149-byte string literal not displayed */
	PrometheusPushJob    string                            `` /* 135-byte string literal not displayed */
	PrometheusPushFormat string                            `` /* 126-byte string literal not displayed */
	PrometheusLabels     map[string]string                 `mapstructure:"prometheus-labels" description:"Additional prometheus labels to set"`
	SystemdDropInFiles   []string                          `` /* 185-byte string literal not displayed */
	Environment          map[string]ConfidentialValue      `mapstructure:"env" description:"Additional environment variables to set in any child process"`
	Init                 *InitSection                      `mapstructure:"init"`
	Backup               *BackupSection                    `mapstructure:"backup"`
	Retention            *RetentionSection                 `mapstructure:"retention" command:"forget"`
	Check                *SectionWithScheduleAndMonitoring `mapstructure:"check"`
	Prune                *SectionWithScheduleAndMonitoring `mapstructure:"prune"`
	Forget               *SectionWithScheduleAndMonitoring `mapstructure:"forget"`
	Copy                 *CopySection                      `mapstructure:"copy"`
	OtherSections        map[string]*GenericSection        `show:",remain"`
	// contains filtered or unexported fields
}

type ProfileInfo interface {
	// PropertySet contains properties shared across sections
	PropertySet
	// Sections returns a list of all known section names
	Sections() []string
	// SectionInfo returns information for a named section
	SectionInfo(name string) SectionInfo
}

type ProfileTemplateData struct {
	Name string
}

type PropertyInfo interface {
	// Named provides Name and Description of the property
	Named
	// IsOption indicates whether the property is a restic command option
	IsOption() bool
	// Option provides the restic option when IsOption is true
	Option() restic.Option
	// IsRequired indicates whether the property must be present in its PropertySet
	IsRequired() bool
	// IsDeprecated indicates whether the property is discontinued
	IsDeprecated() bool
	// IsSingle indicates that the property can be defined only once.
	IsSingle() bool
	// IsMultiType indicates that more than one of CanBeString, CanBeNumeric, CanBeBool & CanBePropertySet returns true
	IsMultiType() bool
	// IsAnyType indicates that all of CanBeString, CanBeNumeric & CanBeBool return true
	IsAnyType() bool
	// CanBeString indicates that the value can a string value
	CanBeString() bool
	// CanBeNumeric indicates that the value can be numeric
	CanBeNumeric() bool
	// CanBeBool indicates that the value can be boolean true or false
	CanBeBool() bool
	// CanBeNil indicates that the value can be set to null (or undefined)
	CanBeNil() bool
	// CanBePropertySet indicates that the property can be a property set (= nested object or array of objects)
	CanBePropertySet() bool
	// PropertySet returns the property set that this property can be filled with (possibly nil)
	PropertySet() NamedPropertySet
	// Format may provide a string describing the expected input format (e.g. time, duration, base64, etc.).
	Format() string
	// ValidationPattern may provide a regular expression to validate the value
	ValidationPattern() string
	// MustBeInteger indicates that a numeric value must be integer
	MustBeInteger() bool
	// DefaultValue returns the default value(s)
	DefaultValue() []string
	// ExampleValues may provide example values
	ExampleValues() []string
	// EnumValues may provide a list of all possible values
	EnumValues() []string
	// NumericRange may provide a valid range for numbers
	NumericRange() NumericRange
}

type PropertySet interface {
	// TypeName returns the name of the type that declared the property set. The name may be empty.
	TypeName() string
	// IsClosed indicates that a property set supports only know properties (as opposed to a non-closed set that may hold arbitrary properties)
	IsClosed() bool
	// IsAllOptions indicates that all properties in this set return IsOption true
	IsAllOptions() bool
	// Properties provides the names of all known config properties in the set
	Properties() []string
	// PropertyInfo provides information on a named property
	PropertyInfo(name string) PropertyInfo
	// OtherPropertyInfo provides information on arbitrary properties in a set where IsClosed is false. Is nil if any arbitrary property is supported.
	OtherPropertyInfo() PropertyInfo
}

type RetentionSection struct {
	ScheduleBaseSection `mapstructure:",squash" deprecated:"0.11.0"`
	OtherFlagsSection   `mapstructure:",squash"`
	BeforeBackup        maybe.Bool `mapstructure:"before-backup" description:"Apply retention before starting the backup command"`
	AfterBackup         maybe.Bool `` /* 198-byte string literal not displayed */
}

type RunShellCommands interface {
	GetRunShellCommands() *RunShellCommandsSection
}

type RunShellCommandsSection struct {
	RunBefore    []string `mapstructure:"run-before" description:"Run shell command(s) before a restic command"`
	RunAfter     []string `mapstructure:"run-after" description:"Run shell command(s) after a successful restic command"`
	RunAfterFail []string `mapstructure:"run-after-fail" description:"Run shell command(s) after failed restic or shell commands"`
	RunFinally   []string `mapstructure:"run-finally" description:"Run shell command(s) always, after all other commands"`
}

type Schedule struct {
	Group      string        `mapstructure:"group"`
	Profiles   []string      `mapstructure:"profiles"`
	Command    string        `mapstructure:"run"`
	Schedule   []string      `mapstructure:"schedule"`
	Permission string        `mapstructure:"permission"`
	Log        string        `mapstructure:"log"`
	Priority   string        `mapstructure:"priority"`
	LockMode   string        `mapstructure:"lock-mode"`
	LockWait   time.Duration `mapstructure:"lock-wait"`
}

type ScheduleBaseSection struct {
	Schedule                        []string      `` /* 254-byte string literal not displayed */
	SchedulePermission              string        `` /* 261-byte string literal not displayed */
	ScheduleLog                     string        `` /* 179-byte string literal not displayed */
	SchedulePriority                string        `` /* 154-byte string literal not displayed */
	ScheduleLockMode                string        `` /* 238-byte string literal not displayed */
	ScheduleLockWait                time.Duration `` /* 172-byte string literal not displayed */
	ScheduleEnvCapture              []string      `` /* 390-byte string literal not displayed */
	ScheduleIgnoreOnBattery         bool          `` /* 136-byte string literal not displayed */
	ScheduleIgnoreOnBatteryLessThan int           `` /* 193-byte string literal not displayed */
	ScheduleAfterNetworkOnline      bool          `` /* 155-byte string literal not displayed */
}

type ScheduleConfig struct {
	Title                   string
	SubTitle                string
	Schedules               []string
	Permission              string
	WorkingDirectory        string
	Command                 string
	Arguments               []string
	Environment             []string
	JobDescription          string
	TimerDescription        string
	Priority                string
	Log                     string
	LockMode                string
	LockWait                time.Duration
	ConfigFile              string
	Flags                   map[string]string
	RemoveOnly              bool
	IgnoreOnBattery         bool
	IgnoreOnBatteryLessThan int
	AfterNetworkOnline      bool
	SystemdDropInFiles      []string
}

type ScheduleLockMode int8

type ScheduleTemplateData struct {
	Name string
}

type Scheduling interface {
	GetSchedule() *ScheduleBaseSection
}

type SectionInfo interface {
	// Named provides Name and Description of the section
	Named
	// PropertySet contains properties for this section
	PropertySet
	// IsCommandSection indicates whether the section configures a restic command
	IsCommandSection() bool
	// Command provides the restic command for the section when this is a command section
	Command() restic.CommandIf
}

type SectionWithScheduleAndMonitoring struct {
	ScheduleBaseSection    `mapstructure:",squash"`
	SendMonitoringSections `mapstructure:",squash"`
	OtherFlagsSection      `mapstructure:",squash"`
}

type SendMonitoringHeader struct {
	Name  string            `` /* 171-byte string literal not displayed */
	Value ConfidentialValue `` /* 192-byte string literal not displayed */
}

type SendMonitoringSection struct {
	Method       string                 `` /* 128-byte string literal not displayed */
	URL          ConfidentialValue      `mapstructure:"url" format:"uri" description:"URL of the target to send to"`
	Headers      []SendMonitoringHeader `mapstructure:"headers" description:"Additional HTTP headers to send with the request"`
	Body         string                 `mapstructure:"body" description:"Request body, overrides \"body-template\""`
	BodyTemplate string                 `` /* 193-byte string literal not displayed */
	SkipTLS      bool                   `` /* 131-byte string literal not displayed */
}

type SendMonitoringSections struct {
	SendBefore    []SendMonitoringSection `mapstructure:"send-before" description:"Send HTTP request(s) before a restic command"`
	SendAfter     []SendMonitoringSection `mapstructure:"send-after" description:"Send HTTP request(s) after a successful restic command"`
	SendAfterFail []SendMonitoringSection `mapstructure:"send-after-fail" description:"Send HTTP request(s) after failed restic or shell commands"`
	SendFinally   []SendMonitoringSection `mapstructure:"send-finally" description:"Send HTTP request(s) always, after all other commands"`
}

type StreamErrorSection struct {
	Pattern    string `` /* 138-byte string literal not displayed */
	MinMatches int    `` /* 147-byte string literal not displayed */
	MaxRuns    int    `mapstructure:"max-runs" range:"[0:]" description:"Maximum amount of times that \"run\" is started ; 0 for no limit"`
	Run        string `mapstructure:"run" description:"The shell command to run when the pattern matches"`
}

type TemplateData struct {
	templates.DefaultData
	Profile   ProfileTemplateData
	Schedule  ScheduleTemplateData
	ConfigDir string
}

type TemplateInfoData struct {
	templates.DefaultData
	Global, Group       PropertySet
	Profile             ProfileInfo
	KnownResticVersions []string
}

type Version int