Documentation
¶
Index ¶
- Variables
- func NewCreateCommand() cmd.Command
- func NewDownloadCommand() cmd.Command
- func NewListCommand() cmd.Command
- func NewRemoveCommand() cmd.Command
- func NewRestoreCommand() cmd.Command
- func NewShowCommand() cmd.Command
- func NewUploadCommand() cmd.Command
- type APIClient
- type ArchiveReader
- type CommandBase
- type RestoreAPI
Constants ¶
This section is empty.
Variables ¶
var BootstrapFunc = bootstrap.Bootstrap
Functions ¶
func NewCreateCommand ¶
NewCreateCommand returns a command used to create backups.
func NewDownloadCommand ¶
NewDownloadCommand returns a commant used to download backups.
func NewListCommand ¶
NewListCommand returns a command used to list metadata for backups.
func NewRemoveCommand ¶
NewRemoveCommand returns a command used to remove a backup from remote storage.
func NewRestoreCommand ¶
NewRestoreCommand returns a command used to restore a backup.
func NewShowCommand ¶
NewShowCommand returns a command used to show metadata for a backup.
func NewUploadCommand ¶
NewUploadCommand returns a command used to send a backup achive file to remote storage.
Types ¶
type APIClient ¶
type APIClient interface {
io.Closer
// Create sends an RPC request to create a new backup.
Create(notes string) (*params.BackupsMetadataResult, error)
// Info gets the backup's metadata.
Info(id string) (*params.BackupsMetadataResult, error)
// List gets all stored metadata.
List() (*params.BackupsListResult, error)
// Download pulls the backup archive file.
Download(id string) (io.ReadCloser, error)
// Upload pushes a backup archive to storage.
Upload(ar io.ReadSeeker, meta params.BackupsMetadataResult) (string, error)
// Remove removes the stored backup.
Remove(id string) error
// Restore will restore a backup with the given id into the controller.
Restore(string, backups.ClientConnection) error
// RestoreReader will restore a backup file into the controller.
RestoreReader(io.ReadSeeker, *params.BackupsMetadataResult, backups.ClientConnection) error
}
APIClient represents the backups API client functionality used by the backups command.
type ArchiveReader ¶
type ArchiveReader interface {
io.ReadSeeker
io.Closer
}
ArchiveReader can read a backup archive.
type CommandBase ¶
type CommandBase struct {
// TODO(wallyworld) - remove Log when backup command is flattened.
Log *cmd.Log
modelcmd.ModelCommandBase
}
CommandBase is the base type for backups sub-commands.
func (*CommandBase) NewAPIClient ¶
func (c *CommandBase) NewAPIClient() (APIClient, error)
NewAPIClient returns a client for the backups api endpoint.
func (*CommandBase) SetFlags ¶
func (c *CommandBase) SetFlags(f *gnuflag.FlagSet)
SetFlags implements Command.SetFlags.
type RestoreAPI ¶
type RestoreAPI interface {
// Close is taken from io.Closer.
Close() error
// Restore is taken from backups.Client.
Restore(backupId string, newClient backups.ClientConnection) error
// RestoreReader is taken from backups.Client.
RestoreReader(r io.ReadSeeker, meta *params.BackupsMetadataResult, newClient backups.ClientConnection) error
}
RestoreAPI is used to invoke various API calls.