types

type ApplierInfo struct {
	SnapFilePath string
	SnapIndex    int
}

type CompactOptions struct {
	*RestoreOptions
	*CompactorConfig
	TempDir string
}

type CompactorConfig struct {
	FullSnapshotLeaseName     string            `json:"fullSnapshotLeaseName,omitempty"`
	DeltaSnapshotLeaseName    string            `json:"deltaSnapshotLeaseName,omitempty"`
	SnapshotTimeout           wrappers.Duration `json:"snapshotTimeout,omitempty"`
	DefragTimeout             wrappers.Duration `json:"defragTimeout,omitempty"`
	MetricsScrapeWaitDuration wrappers.Duration `json:"metricsScrapeWaitDuration,omitempty"`
	NeedDefragmentation       bool              `json:"needDefrag,omitempty"`
	EnabledLeaseRenewal       bool              `json:"enabledLeaseRenewal"`
}

type Config struct {
	// ReelectionPeriod defines the Period after which leadership status is checked.
	ReelectionPeriod wrappers.Duration `json:"reelectionPeriod,omitempty"`
	// EtcdConnectionTimeout defines the timeout duration for etcd client connection during leader election.
	EtcdConnectionTimeout wrappers.Duration `json:"etcdConnectionTimeout,omitempty"`
}

type EtcdConnectionConfig struct {
	CertFile         string   `json:"certFile,omitempty"`
	Username         string   `json:"username,omitempty"`
	Password         string   `json:"password,omitempty"`
	KeyFile          string   `json:"keyFile,omitempty"`
	CaFile           string   `json:"caFile,omitempty"`
	ServiceEndpoints []string `json:"serviceEndpoints,omitempty"`
	// Endpoints are the endpoints from which the backup will be take or defragmentation will be called.
	// This need not be necessary match the entire etcd cluster.
	Endpoints          []string          `json:"endpoints"`
	ConnectionTimeout  wrappers.Duration `json:"connectionTimeout,omitempty"`
	SnapshotTimeout    wrappers.Duration `json:"snapshotTimeout,omitempty"`
	DefragTimeout      wrappers.Duration `json:"defragTimeout,omitempty"`
	MaxCallSendMsgSize int               `json:"maxCallSendMsgSize,omitempty"`
	InsecureTransport  bool              `json:"insecureTransport,omitempty"`
	InsecureSkipVerify bool              `json:"insecureSkipVerify,omitempty"`
}

type EtcdMemberStatusCallbackFunc func(context.Context, *EtcdConnectionConfig, time.Duration, *logrus.Entry) (bool, bool, error)

type Event struct {
	EtcdEvent *clientv3.Event `json:"etcdEvent"`
	Time      time.Time       `json:"time"`
}

type ExponentialBackoffConfig struct {
	// Multiplier defines multiplicative factor for Exponential-Backoff mechanism.
	Multiplier uint `json:"multiplier,omitempty"`
	// AttemptLimit defines the threshold no. of attempts to retry before a ThresholdTime is achieved.
	AttemptLimit uint `json:"attemptLimit,omitempty"`
	// ThresholdTime defines the upper bound time of Exponential-Backoff mechanism for retry operation.
	ThresholdTime wrappers.Duration `json:"thresholdTime,omitempty"`
}

type FetcherInfo struct {
	Snapshot  Snapshot
	SnapIndex int
}

type HealthConfig struct {
	FullSnapshotLeaseName       string            `json:"fullSnapshotLeaseName,omitempty"`
	DeltaSnapshotLeaseName      string            `json:"deltaSnapshotLeaseName,omitempty"`
	HeartbeatDuration           wrappers.Duration `json:"heartbeatDuration,omitempty"`
	SnapshotLeaseRenewalEnabled bool              `json:"snapshotLeaseRenewalEnabled,omitempty"`
	MemberLeaseRenewalEnabled   bool              `json:"memberLeaseRenewalEnabled,omitempty"`
}

type InitIndex int

type LeaderCallbacks struct {
	// OnStartedLeading is called when a LeaderElector client starts leading.
	OnStartedLeading func(context.Context)
	// OnStoppedLeading is called when a LeaderElector client stops leading.
	OnStoppedLeading func()
}

type MemberLeaseCallbacks struct {
	// StartLeaseRenewal is called when etcd member moved from StateUnknown to either StateLeader or StateFollower.
	StartLeaseRenewal func()
	// OnStoppedLeading is called when etcd member moved to StateUnknown from any other State.
	StopLeaseRenewal func()
}

type NewClientFactoryFunc func(cfg EtcdConnectionConfig, opts ...client.Option) client.Factory

type PromoteLearnerCallback struct {
	Promote func(context.Context, *logrus.Entry)
}

type RestorationConfig struct {
	InitialCluster           string   `json:"initialCluster"`
	InitialClusterToken      string   `json:"initialClusterToken,omitempty"`
	DataDir                  string   `json:"dataDir,omitempty"`
	TempSnapshotsDir         string   `json:"tempDir,omitempty"`
	Name                     string   `json:"name"`
	AutoCompactionRetention  string   `json:"autoCompactionRetention,omitempty"`
	AutoCompactionMode       string   `json:"autoCompactionMode,omitempty"`
	InitialAdvertisePeerURLs []string `json:"initialAdvertisePeerURLs"`
	MaxTxnOps                uint     `json:"MaxTxnOps,omitempty"`
	MaxRequestBytes          uint     `json:"MaxRequestBytes,omitempty"`
	MaxCallSendMsgSize       int      `json:"maxCallSendMsgSize,omitempty"`
	EmbeddedEtcdQuotaBytes   int64    `json:"embeddedEtcdQuotaBytes,omitempty"`
	MaxFetchers              uint     `json:"maxFetchers,omitempty"`
	SkipHashCheck            bool     `json:"skipHashCheck,omitempty"`
}

type RestoreOptions struct {
	Config      *RestorationConfig
	ClusterURLs types.URLsMap
	// Base full snapshot + delta snapshots to restore from
	BaseSnapshot     *Snapshot
	NewClientFactory NewClientFactoryFunc
	PeerURLs         types.URLs
	DeltaSnapList    SnapList
	// OriginalClusterSize indicates the actual cluster size from the ETCD config
	OriginalClusterSize int
}

type SecondarySnapstoreConfig struct {
	StoreConfig       *SnapstoreConfig
	BackupSyncEnabled bool              `json:"backupSyncEnabled,omitempty"`
	SyncPeriod        wrappers.Duration `json:"syncPeriod,omitempty"`
}

type SnapList []*Snapshot

type SnapStore interface {
	// Fetch should open reader for the snapshot file from store.
	Fetch(Snapshot) (io.ReadCloser, error)
	// List returns a sorted list (based on the last revision, ascending) of all snapshots in the store.
	// includeAll specifies whether to include all snapshots while listing, including those with exclude tags.
	// Snapshots with exclude tags are not listed unless includeAll is set to true.
	// Note: "includeAll" boolean is only applicable for storage provider: ABS and GCS.
	List(includeAll bool) (SnapList, error)
	// Save will write the snapshot to store.
	Save(Snapshot, io.ReadCloser) error
	// Delete should delete the snapshot file from store.
	Delete(Snapshot) error
}

type Snapshot struct {
	CreatedOn              time.Time `json:"createdOn"`
	ImmutabilityExpiryTime time.Time `json:"immutabilityExpriyTime"`
	VersionID              *string   `json:"versionID"` // It is used only for AWS S3 object lock immutability.
	Kind                   string    `json:"kind"`      // incr:incremental, full:full
	SnapDir                string    `json:"snapDir"`
	SnapName               string    `json:"snapName"`
	Prefix                 string    `json:"prefix"`            // Points to correct prefix of a snapshot in snapstore (Required for Backward Compatibility)
	CompressionSuffix      string    `json:"compressionSuffix"` // CompressionSuffix depends on compression policy
	StartRevision          int64     `json:"startRevision"`
	LastRevision           int64     `json:"lastRevision"` // latest revision of snapshot
	IsChunk                bool      `json:"isChunk"`
	IsFinal                bool      `json:"isFinal"`
}

type SnapshotterConfig struct {
	FullSnapshotSchedule         string            `json:"schedule,omitempty"`
	GarbageCollectionPolicy      string            `json:"garbageCollectionPolicy,omitempty"`
	DeltaSnapshotPeriod          wrappers.Duration `json:"deltaSnapshotPeriod,omitempty"`
	DeltaSnapshotMemoryLimit     uint              `json:"deltaSnapshotMemoryLimit,omitempty"`
	GarbageCollectionPeriod      wrappers.Duration `json:"garbageCollectionPeriod,omitempty"`
	MaxBackups                   uint              `json:"maxBackups,omitempty"`
	DeltaSnapshotRetentionPeriod wrappers.Duration `json:"deltaSnapshotRetentionPeriod,omitempty"`
}

type SnapstoreConfig struct {
	// Provider indicated the cloud provider.
	Provider string `json:"provider,omitempty"`
	// Container holds the name of bucket or container to which snapshot will be stored.
	Container string `json:"container"`
	// EndpointOverride denotes the storage endpoint that will be used to override the provider's default.
	EndpointOverride string `json:"endpointOverride,omitempty"`
	// Prefix holds the prefix or directory under StorageContainer under which snapshot will be stored.
	Prefix string `json:"prefix,omitempty"`
	// Temporary Directory
	TempDir string `json:"tempDir,omitempty"`
	// EnvPrefix is the prefix to be used for environment variables.
	// It is used to differentiate between primary and secondary snapstore configs.
	EnvPrefix string `json:"envPrefix,omitempty"`
	// MaxParallelChunkUploads holds the maximum number of parallel chunk uploads allowed.
	MaxParallelChunkUploads uint `json:"maxParallelChunkUploads,omitempty"`
	// MinChunkSize holds the minimum size for a multi-part chunk upload.
	MinChunkSize int64 `json:"minChunkSize,omitempty"`
	// IsSource determines if this SnapStore is the source for a copy operation
	IsSource bool `json:"isSource,omitempty"`
}