download

Documentation

Index

• type CMDGenerator
  • func (gen *CMDGenerator) Generate(ctx context.Context, datasetID, instanceID, edition, version string) error
• type CantabularGenerator
  • func (gen *CantabularGenerator) Generate(ctx context.Context, datasetID, instanceID, edition, version string) error
• type CantabularGeneratorDownloads
• type GenerateDownloads
• type GenerateDownloadsEvent
• type GeneratorError
  • func (genErr GeneratorError) Error() string
• type KafkaProducer

Types

type CMDGenerator

type CMDGenerator struct {
	Producer   KafkaProducer
	Marshaller GenerateDownloadsEvent
}

Generator kicks off a full dataset version download task

func (*CMDGenerator) Generate

func (gen *CMDGenerator) Generate(ctx context.Context, datasetID, instanceID, edition, version string) error

Generate the full file download files for the specified dataset/edition/version

type CantabularGenerator

type CantabularGenerator struct {
	Producer   KafkaProducer
	Marshaller GenerateDownloadsEvent
}

Generator kicks off a full dataset version download task

func (*CantabularGenerator) Generate

func (gen *CantabularGenerator) Generate(ctx context.Context, datasetID, instanceID, edition, version string) error

Generate the full file download files for the specified dataset/edition/version

type CantabularGeneratorDownloads

type CantabularGeneratorDownloads struct {
	InstanceID     string   `avro:"instance_id"`
	DatasetID      string   `avro:"dataset_id"`
	Edition        string   `avro:"edition"`
	Version        string   `avro:"version"`
	FilterOutputID string   `avro:"filter_output_id"`
	Dimensions     []string `avro:"dimensions"`
}

type GenerateDownloads

type GenerateDownloads struct {
	FilterOutputID string `avro:"filter_output_id"`
	InstanceID     string `avro:"instance_id"`
	DatasetID      string `avro:"dataset_id"`
	Edition        string `avro:"edition"`
	Version        string `avro:"version"`
}

type GenerateDownloadsEvent

type GenerateDownloadsEvent interface {
	Marshal(s interface{}) ([]byte, error)
}

GenerateDownloadsEvent marshal the event into avro format

type GeneratorError

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

GeneratorError is a wrapper for errors returned from the Generator

func (GeneratorError) Error

func (genErr GeneratorError) Error() string

Error return details about the error

type KafkaProducer

type KafkaProducer interface {
	Output() chan kafka.BytesMessage
}

KafkaProducer sends an outbound kafka message