Documentation
¶
Index ¶
- Variables
- type Plugin
- type UnimplementedPlugin
- func (u *UnimplementedPlugin) Backup(_ context.Context, _ spec.App, _ provider.Opts) error
- func (u *UnimplementedPlugin) Description() string
- func (u *UnimplementedPlugin) Link(_ context.Context, _ spec.App, _ provider.Opts) error
- func (u *UnimplementedPlugin) Name() string
- func (u *UnimplementedPlugin) Restore(_ context.Context, _ spec.App, _ provider.Opts) error
- func (u *UnimplementedPlugin) Unlink(_ context.Context, _ spec.App, _ provider.Opts) error
- func (u *UnimplementedPlugin) Version() string
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrUnimplemented = errors.New("not implemented")
View Source
var Unknown = "unknown"
Functions ¶
This section is empty.
Types ¶
type Plugin ¶
type Plugin interface {
// Name returns the name of the plugin.
Name() string
// Description returns a brief description of the plugin.
Description() string
// Version returns the version of the plugin.
Version() string
// Backup performs a backup of the application data.
Backup(ctx context.Context, app spec.App, opts provider.Opts) error
// Restore restores the application data from a backup.
Restore(ctx context.Context, app spec.App, opts provider.Opts) error
// Link applications with the plugin.
Link(ctx context.Context, app spec.App, opts provider.Opts) error
// Unlink removes the link with the plugin.
Unlink(ctx context.Context, app spec.App, opts provider.Opts) error
}
Plugin interface defines the methods that a plugin must implement.
type UnimplementedPlugin ¶
type UnimplementedPlugin struct{}
func (*UnimplementedPlugin) Description ¶
func (u *UnimplementedPlugin) Description() string
Description returns a brief description of the plugin.
func (*UnimplementedPlugin) Name ¶
func (u *UnimplementedPlugin) Name() string
Name returns the name of the plugin.
func (*UnimplementedPlugin) Version ¶
func (u *UnimplementedPlugin) Version() string
Version returns the version of the plugin.
Click to show internal directories.
Click to hide internal directories.