retrieval

Documentation

Index

• type Backend
• type BackendConfig
• type Factory

Types

type Backend

type Backend interface {
	Retrieve(context.Context, string, string) error
}

Backend is the minimal interface that must be implemented by a retriever. Retrievers are responsible for obtaining projects, the base entity on which neighbor operates. An example retriever is Git.

type BackendConfig

type BackendConfig struct {
	// AuthRequired is indicates the method, if one, to be used for authentication
	// by the retrieval backend.
	AuthMethod string

	// Config is for optional or secondary configuration.
	Config map[string]string
}

BackendConfig contains the configuration parameters for a retrieval backend.

type Factory

type Factory func(context.Context, *BackendConfig) (Backend, error)

Factory is a factory function for constructing retrievers backend.