Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func RectifyKeywords ¶ added in v0.5.0
RectifyKeywords sanitises a slice of keywords, splitting any that contain commas into seperate keywords and trimming any whitespace. It also optionally takes a limit which truncates the keywords to the desired amount. This value can be -1 for no truncation.
func ValidateTopics ¶ added in v0.11.0
Types ¶
type CMDData ¶ added in v0.7.0
type CMDData struct {
UID string `json:"uid"`
VersionDetails VersionDetails `json:"version"`
DatasetDetails DatasetDetails `json:"datasetdetails"`
}
CMDData provides model for datasetAPI metadata response
type ContentPublished ¶
type ContentPublished struct {
URI string `avro:"uri"`
DataType string `avro:"data_type"`
CollectionID string `avro:"collection_id"`
JobID string `avro:"job_id"`
SearchIndex string `avro:"search_index"`
TraceID string `avro:"trace_id"`
}
ContentPublished provides an avro structure for a Content Published event
type DatasetDetails ¶ added in v0.7.0
type DatasetDetails struct {
Title string `json:"title"`
Description string `json:"description"`
Keywords []string `json:"keywords,omitempty"`
}
DatasetDetails represents a DatasetDetails for an edition within a dataset
type Description ¶
type Description struct {
CDID string `json:"cdid"`
DatasetID string `json:"datasetId"`
Edition string `json:"edition"`
Keywords []string `json:"keywords,omitempty"`
MetaDescription string `json:"metaDescription"`
ReleaseDate string `json:"releaseDate"`
Summary string `json:"summary"`
Title string `json:"title"`
Topics []string `json:"topics,omitempty"`
}
type SearchDataImport ¶
type SearchDataImport struct {
UID string `avro:"uid"`
DataType string `avro:"data_type"`
JobID string `avro:"job_id"`
SearchIndex string `avro:"search_index"`
CDID string `avro:"cdid"`
DatasetID string `avro:"dataset_id"`
Keywords []string `avro:"keywords"`
MetaDescription string `avro:"meta_description"`
ReleaseDate string `avro:"release_date"`
Summary string `avro:"summary"`
Title string `avro:"title"`
Topics []string `avro:"topics"`
TraceID string `avro:"trace_id"`
}
SearchDataImport provides event data for a search data import
func MapVersionMetadataToSearchDataImport ¶ added in v0.7.0
func MapVersionMetadataToSearchDataImport(cmdData CMDData) SearchDataImport
MapDatasetVersionToSearchDataImport performs default mapping of datasetAPI data to a version metadata struct.
func MapZebedeeDataToSearchDataImport ¶ added in v0.5.0
func MapZebedeeDataToSearchDataImport(zebedeeData ZebedeeData, keywordsLimit int) SearchDataImport
MapZebedeeDataToSearchDataImport Performs default mapping of zebedee data to a SearchDataImport struct. It also optionally takes a limit which truncates the keywords to the desired amount. This value can be -1 for no truncation.
type VersionDetails ¶ added in v0.7.0
type VersionDetails struct {
ReleaseDate string `json:"release_date,omitempty"`
}
Version represents a version for an edition within a dataset
type ZebedeeData ¶
type ZebedeeData struct {
UID string `json:"uid"`
DataType string `json:"type"`
Description Description `json:"description"`
}
ZebedeeData provides model for zebedee publisheddata response
Source Files