plugins

type BaseExtractor struct {
	ScopeNotRequired bool
	BasePlugin
}

type BasePlugin struct {
	UrnScope  string
	RawConfig map[string]interface{}
	// contains filtered or unexported fields
}

type Config struct {
	URNScope  string
	RawConfig map[string]interface{}
}

type ConfigError struct {
	Key     string
	Message string
}

type Emit func(models.Record)

type Extractor interface {
	Plugin
	Extract(ctx context.Context, emit Emit) (err error)
}

type Info struct {
	Description  string   `yaml:"description"`
	SampleConfig string   `yaml:"sample_config"`
	Tags         []string `yaml:"tags"`
	Summary      string   `yaml:"summary"`
}

type InvalidConfigError struct {
	Type       PluginType
	PluginName string
	Errors     []ConfigError
}

type NotFoundError struct {
	Type PluginType
	Name string
}

type Plugin interface {
	// Info returns plugin's information.
	Info() Info

	// Validate checks if the given options is valid for the plugin.
	Validate(config Config) error

	// Init will be called once before running the plugin.
	// This is where you want to initiate any client or test any connection to external service.
	Init(ctx context.Context, config Config) error
}

type PluginType string

type Processor interface {
	Plugin
	Process(ctx context.Context, src models.Record) (dst models.Record, err error)
}

type RetryError struct {
	Err error
}

type Syncer interface {
	Plugin
	Sink(ctx context.Context, batch []models.Record) (err error)

	// Close will be called once after everything is done
	Close() error
}