datasets

Documentation

Index

• Constants
• type BundleFormat
• type DataSet
• type DataSetFormat
• type DataSource
• type IgnoreObjectServiceJourney
• type IgnoreObjects
• type ImportDestination
• type Provider
• type SourceAuthentication
• type SupportedObjects

Constants

const (
	DataSetFormatNaPTAN            DataSetFormat = "gb-naptan"
	DataSetFormatTransXChange                    = "gb-transxchange"
	DataSetFormatTravelineNOC                    = "gb-travelinenoc"
	DataSetFormatCIF                             = "gb-cif"
	DataSetFormatNationalRailTOC                 = "gb-nationalrailtoc"
	DataSetFormatNetworkRailCorpus               = "gb-networkrailcorpus"
	DataSetFormatSiriVM                          = "eu-siri-vm"
	DataSetFormatSiriSX                          = "eu-siri-sx"
	DataSetFormatGTFSSchedule                    = "gtfs-schedule"
	DataSetFormatGTFSRealtime                    = "gtfs-realtime"
)

const (
	BundleFormatNone  BundleFormat = "none"
	BundleFormatZIP                = "zip"
	BundleFormatGZ                 = "gz"
	BundleFormatTarGZ              = "tar.gz"
)

Types

type BundleFormat

type BundleFormat string

type DataSet

type DataSet struct {
	Identifier    string
	DataSourceRef string `json:"-"`
	Format        DataSetFormat

	Provider Provider

	Source               string
	SourceAuthentication SourceAuthentication `json:"-"`

	DatasetSize     string
	RefreshInterval time.Duration

	UnpackBundle      BundleFormat `json:"-"`
	SupportedObjects  SupportedObjects
	IgnoreObjects     IgnoreObjects
	ImportDestination ImportDestination `json:"-"`

	CustomConfig map[string]string

	LinkedDataset string

	DownloadHandler func(*http.Request) `json:"-"`

	// Internal only
	Queue *rmq.Queue `json:"-"`
}

type DataSetFormat

type DataSetFormat string

type DataSource

type DataSource struct {
	Identifier string
	Region     string
	Provider   Provider
	Datasets   []DataSet
}

type IgnoreObjectServiceJourney

type IgnoreObjectServiceJourney struct {
	ByOperator []string
}

type IgnoreObjects

type IgnoreObjects struct {
	// Operators      bool
	// OperatorGroups bool
	// Stops          bool
	// StopGroups     bool
	Services IgnoreObjectServiceJourney
	Journeys IgnoreObjectServiceJourney
}

type ImportDestination

type ImportDestination string

const (
	ImportDestinationDatabase      ImportDestination = "database"
	ImportDestinationRealtimeQueue                   = "realtime-queue"
)

type Provider

type Provider struct {
	Name    string
	Website string
}

type SourceAuthentication

type SourceAuthentication struct {
	Query  map[string]string
	Header map[string]string
	Basic  struct {
		Username string
		Password string
	}
	Custom string
}

type SupportedObjects

type SupportedObjects struct {
	Operators      bool
	OperatorGroups bool
	Stops          bool
	StopGroups     bool
	Services       bool
	Journeys       bool

	RealtimeJourneys bool
	ServiceAlerts    bool
}