Documentation
¶
Overview ¶
Package data_source contains the API for the data source syncer.
Index ¶
Constants ¶
const DataSourceSyncerName = "dataSourceSyncer"
DataSourceSyncerName constant should not be used directly when implementing plugins. It's the registration name for the data source syncer 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 DataSourceSyncConfig ¶
DataSourceSyncConfig represents the configuration that is passed from the CLI to the DataAccessSyncer plugin interface. It contains all the necessary configuration parameters for the plugin to function.
type DataSourceSyncResult ¶ added in v0.22.0
type DataSourceSyncResult struct {
Error *api.ErrorResult
}
DataSourceSyncResult represents the result from the data source sync process. A potential error is also modeled in here so specific errors remain intact when passed over RPC.
type DataSourceSyncer ¶
type DataSourceSyncer interface {
SyncDataSource(config *DataSourceSyncConfig) DataSourceSyncResult
}
DataSourceSyncer interface needs to be implemented by any plugin that wants to import data objects into a Raito data source.
type DataSourceSyncerPlugin ¶
type DataSourceSyncerPlugin struct {
Impl DataSourceSyncer
}
DataSourceSyncerPlugin 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 (DataSourceSyncerPlugin) Client ¶
func (DataSourceSyncerPlugin) Client(b *plugin.MuxBroker, c *rpc.Client) (interface{}, error)
func (*DataSourceSyncerPlugin) Server ¶
func (p *DataSourceSyncerPlugin) Server(*plugin.MuxBroker) (interface{}, error)
Source Files