connectors

type Connector interface {
	Spec() Spec

	ConsumeAsIterator(ctx context.Context, env *Env, source *Source, logger *zap.Logger) (FileIterator, error)

	// HasAnonymousAccess returns true if external system can be accessed without credentials
	HasAnonymousAccess(ctx context.Context, env *Env, source *Source) (bool, error)
}

type DownloadMetrics struct {
	Connector string
	Ext       string
	Partial   bool
	Duration  time.Duration
	Size      int64
}

type Env struct {
	RepoDriver string
	RepoRoot   string
	// user provided env variables kept with keys converted to uppercase
	Variables           map[string]string
	AllowHostAccess     bool
	StorageLimitInBytes int64
}

type FileIterator interface {
	// Close do cleanup and release resources
	Close() error
	// NextBatch returns a list of file downloaded from external sources
	// NextBatch cleanups file created in previous batch
	NextBatch(limit int) ([]string, error)
	// HasNext can be utlisied to check if iterator has more elements left
	HasNext() bool
}

type PermissionDeniedError struct {
	// contains filtered or unexported fields
}

type PropertySchema struct {
	Key         string
	Type        PropertySchemaType
	Required    bool
	DisplayName string
	Description string
	Placeholder string
	Hint        string
	Href        string
}

type PropertySchemaType int

type SamplePolicy struct {
	Strategy string
	Sample   float32
	Limit    int
}

type Source struct {
	Name          string
	Connector     string
	ExtractPolicy *runtimev1.Source_ExtractPolicy
	Properties    map[string]any
	Timeout       int32
}

type Spec struct {
	DisplayName        string
	Description        string
	ServiceAccountDocs string
	Properties         []PropertySchema
	ConnectorVariables []VariableSchema
	Help               string
}

type VariableSchema struct {
	Key           string
	Default       string
	Help          string
	Secret        bool
	ValidateFunc  func(any interface{}) error
	TransformFunc func(any interface{}) interface{}
}