Documentation
¶
Index ¶
Constants ¶
const InfoName = "info"
InfoName constant should not be used directly when implementing plugins. It's the registration name for the info plugin, used by the CLI and the cli-plugin-base library (RegisterPlugins function) to register the plugins.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BadInputParameterError ¶ added in v0.16.0
BadInputParameterError is returned for when a parameter is set, but has an unexpected value. The Explanation field can be set optionally to explain what is wrong or to give examples of correct input. When this error is returned by the plugin, the CLI will print the plugin parameters (coming from PluginInfo.Parameters).
func (*BadInputParameterError) Error ¶ added in v0.16.0
func (e *BadInputParameterError) Error() string
type ConnectionError ¶ added in v0.16.0
ConnectionError is returned when the plugin cannot connect to the target.
func (*ConnectionError) Error ¶ added in v0.16.0
func (e *ConnectionError) Error() string
type Info ¶ added in v0.12.0
type Info interface {
PluginInfo() PluginInfo
}
Info interface needs to be implemented by all plugins to provide basic plugin information.
type InfoPlugin ¶ added in v0.12.0
type InfoPlugin struct {
Impl Info
}
InfoPlugin is used on the server (CLI) and client (plugin) side to integrate with the plugin system. A plugin should not be using this directly, but instead depend on the cli-plugin-base library to register the plugins.
func (InfoPlugin) Client ¶ added in v0.12.0
func (InfoPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
func (*InfoPlugin) Server ¶ added in v0.12.0
func (p *InfoPlugin) Server(*plugin.MuxBroker) (interface{}, error)
type MissingInputParameterError ¶ added in v0.16.0
type MissingInputParameterError struct {
Parameter string
}
MissingInputParameterError is returned for when a mandatory input parameter is not set. When this error is returned by the plugin, the CLI will print the plugin parameters (coming from PluginInfo.Parameters).
func (*MissingInputParameterError) Error ¶ added in v0.16.0
func (e *MissingInputParameterError) Error() string
type ParameterInfo ¶ added in v0.12.0
ParameterInfo contains the information about a parameter. This is used to inform the CLI user what command-line parameters are expected explicitly for this target (plugin).
func (ParameterInfo) String ¶ added in v0.12.0
func (i ParameterInfo) String() string
type PluginInfo ¶ added in v0.12.0
type PluginInfo struct {
Name string
Description string
Version Version
Parameters []ParameterInfo
}
PluginInfo represents the information about a plugin.
func (PluginInfo) String ¶ added in v0.12.0
func (i PluginInfo) String() string
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package data_source contains the API for the data source syncer.
|
Package data_source contains the API for the data source syncer. |