checkpoints

Documentation

Index

• type CheckpointDownloader
  • func NewDownloader(ctx context.Context, w io.Writer, id string, ...) (CheckpointDownloader, error)

Types

type CheckpointDownloader

type CheckpointDownloader interface {
	Download(context.Context) error
	Close() error
	ListFiles(context.Context) ([]archive.FileEntry, error)
}

CheckpointDownloader defines the interface for downloading checkpoints.

func NewDownloader

func NewDownloader(
	ctx context.Context,
	w io.Writer,
	id string,
	storageConfig *expconf.CheckpointStorageConfig,
	aw archive.ArchiveWriter,
) (CheckpointDownloader, error)

NewDownloader returns a new CheckpointDownloader that writes to w.

• w: the underlying Writer that CheckpointDownloader writes to
• id: the UUID string of the checkpoint to be downloaded
• storageConfig: the CheckpointStorageConfig
• archiveType: The ArchiveType (file format) in which the checkpoint shall be downloaded