repository

Documentation

Index

• Variables
• func ValidRetentionModeNames() map[string]RetentionMode
• type Maintenance
• type MaintenanceSafety
  • func (i MaintenanceSafety) String() string
• type MaintenanceType
  • func (i MaintenanceType) String() string
• type Options
• type PersistentConfig
• type Retention
• type RetentionMode
  • func (i RetentionMode) String() string

Variables

var StringToMaintenanceType = map[string]MaintenanceType{
	CompleteMaintenance.String(): CompleteMaintenance,
	MetadataMaintenance.String(): MetadataMaintenance,
}

Functions

func ValidRetentionModeNames

func ValidRetentionModeNames() map[string]RetentionMode

Types

type Maintenance

type Maintenance struct {
	Type          MaintenanceType   `json:"type"`
	Safety        MaintenanceSafety `json:"safety"`
	Force         bool              `json:"force"`
	CleanupBuffer *time.Duration
}

type MaintenanceSafety

type MaintenanceSafety int

const (
	FullMaintenanceSafety MaintenanceSafety = 0
	//nolint:lll
	// Use only if there's no other kopia instances accessing the repo and the
	// storage backend is strongly consistent.
	// https://github.com/kopia/kopia/blob/f9de453efc198b6e993af8922f953a7e5322dc5f/repo/maintenance/maintenance_safety.go#L42
	NoMaintenanceSafety MaintenanceSafety = 1
)

func (MaintenanceSafety) String

func (i MaintenanceSafety) String() string

type MaintenanceType

type MaintenanceType int

const (
	CompleteMaintenance MaintenanceType = 0 // complete
	MetadataMaintenance MaintenanceType = 1 // metadata
)

func (MaintenanceType) String

func (i MaintenanceType) String() string

type Options

type Options struct {
	User string `json:"user"`
	Host string `json:"host"`
	// ViewTimestamp is the time at which the repo should be opened at if
	// immutable backups are being used. If nil then the current time is used.
	ViewTimestamp *time.Time `json:"viewTimestamp"`
	ReadOnly      bool       `json:"readonly,omitempty"`
}

Repo represents options that are specific to the repo storing backed up data.

type PersistentConfig

type PersistentConfig struct {
	MinEpochDuration *time.Duration
}

PersistentConfig represents configuration info that is persisted in the corso repo and can be updated with repository.UpdatePersistentConfig. Leaving a field as nil will result in no updates being made to it (i.e. PATCH semantics).

type Retention

type Retention struct {
	Mode     *RetentionMode
	Duration *time.Duration
	Extend   *bool
}

Retention contains various options for configuring the retention mode. Takes pointers instead of values so that we can tell the difference between an unset value and a set but invalid value. This allows for partial (re)configuration of things.

type RetentionMode

type RetentionMode int

const (
	UnknownRetention    RetentionMode = 0
	NoRetention         RetentionMode = 1 // none
	GovernanceRetention RetentionMode = 2 // governance
	ComplianceRetention RetentionMode = 3 // compliance
)

func (RetentionMode) String

func (i RetentionMode) String() string