Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

service

package

Go to main page

Versions in this module

v1

v1.27.0

Dec 6, 2024

v1.26.0

Aug 5, 2024

v1.25.0

Jul 19, 2024

Changes in this version

+ type DatasetAPI interface

+ Checker func(context.Context, *healthcheck.CheckState) error

+ GetInstance func(ctx context.Context, ...) (m dataset.Instance, eTag string, err error)

+ GetMetadataURL func(id, edition, version string) (url string)

+ GetOptions func(ctx context.Context, ...) (m dataset.Options, err error)

+ GetOptionsInBatches func(ctx context.Context, ...) (m dataset.Options, err error)

+ GetVersion func(ctx context.Context, ...) (m dataset.Version, err error)

+ GetVersionDimensions func(ctx context.Context, ...) (m dataset.VersionDimensions, err error)

+ GetVersionMetadata func(ctx context.Context, ...) (m dataset.Metadata, err error)

+ PutVersion func(ctx context.Context, ...) error

+ type EventConsumer interface

+ Close func(ctx context.Context) (err error)

+ type ExternalServiceList struct

+ DatasetAPI bool

+ FileStore bool

+ FilterStore bool

+ HealthCheck bool

+ Init Initialiser

+ KafkaConsumer bool

+ KafkaProducer bool

+ ObservationStore bool

+ Vault bool

+ func NewServiceList(initialiser Initialiser) *ExternalServiceList

+ func (e *ExternalServiceList) GetDatasetAPIClient(cfg *config.Config) (DatasetAPI, error)

+ func (e *ExternalServiceList) GetFileStore(cfg *config.Config, vaultClient *vault.Client) (fileStore *file.Store, err error)

+ func (e *ExternalServiceList) GetFilterStore(cfg *config.Config, serviceAuthToken string) (FilterStore, error)

+ func (e *ExternalServiceList) GetHTTPServer(bindAddr string, router http.Handler) HTTPServer

+ func (e *ExternalServiceList) GetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

+ func (e *ExternalServiceList) GetKafkaConsumer(ctx context.Context, cfg *config.Config) (dpkafka.IConsumerGroup, error)

+ func (e *ExternalServiceList) GetKafkaProducer(ctx context.Context, cfg *config.Config) (dpkafka.IProducer, error)

+ func (e *ExternalServiceList) GetObservationStore(ctx context.Context) (observationStore *graph.DB, err error)

+ func (e *ExternalServiceList) GetVault(cfg *config.Config, retries int) (client *vault.Client, err error)

+ type FilterStore interface

+ Checker func(context.Context, *healthcheck.CheckState) error

+ GetFilter func(ctx context.Context, filterID string) (*filter.Model, error)

+ PutCSVData func(ctx context.Context, filterID string, downloadItem filter.Download) error

+ PutStateAsEmpty func(ctx context.Context, filterJobID string) error

+ PutStateAsError func(ctx context.Context, filterJobID string) error

+ type HTTPServer interface

+ ListenAndServe func() error

+ Shutdown func(ctx context.Context) error

+ type HealthChecker interface

+ AddCheck func(name string, checker healthcheck.Checker) (err error)

+ Handler func(w http.ResponseWriter, req *http.Request)

+ Start func(ctx context.Context)

+ Stop func()

+ type Init struct

+ func (e *Init) DoGetDatasetAPIClient(cfg *config.Config) DatasetAPI

+ func (e *Init) DoGetFileStore(cfg *config.Config, vaultClient *vault.Client) (fileStore *file.Store, err error)

+ func (e *Init) DoGetFilterStore(cfg *config.Config, serviceAuthToken string) FilterStore

+ func (e *Init) DoGetHTTPServer(bindAddr string, router http.Handler) HTTPServer

+ func (e *Init) DoGetHealthCheck(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

+ func (e *Init) DoGetKafkaConsumer(ctx context.Context, kafkaCfg *config.KafkaConfig) (dpkafka.IConsumerGroup, error)

+ func (e *Init) DoGetKafkaProducer(ctx context.Context, cfg *config.Config) (dpkafka.IProducer, error)

+ func (e *Init) DoGetObservationStore(ctx context.Context) (observationStore *graph.DB, err error)

+ func (e *Init) DoGetVault(cfg *config.Config, retries int) (client *vault.Client, err error)

+ type Initialiser interface

+ DoGetDatasetAPIClient func(cfg *config.Config) DatasetAPI

+ DoGetFileStore func(cfg *config.Config, vaultClient *vault.Client) (fileStore *file.Store, err error)

+ DoGetFilterStore func(cfg *config.Config, serviceAuthToken string) FilterStore

+ DoGetHTTPServer func(bindAddr string, router http.Handler) HTTPServer

+ DoGetHealthCheck func(cfg *config.Config, buildTime, gitCommit, version string) (HealthChecker, error)

+ DoGetKafkaConsumer func(ctx context.Context, kafkaCfg *config.KafkaConfig) (kafka.IConsumerGroup, error)

+ DoGetKafkaProducer func(ctx context.Context, cfg *config.Config) (kafka.IProducer, error)

+ DoGetObservationStore func(ctx context.Context) (observationStore *graph.DB, err error)

+ DoGetVault func(cfg *config.Config, retries int) (client *vault.Client, err error)

+ type Service struct

+ func Run(ctx context.Context, serviceList *ExternalServiceList, ...) (*Service, error)

+ func (svc *Service) Close(ctx context.Context) error