models

Documentation

Index

• type Dimension
• type EsBulkItemResponse
• type EsBulkItemResponseData
• type EsBulkItemResponseError
• type EsBulkResponse
• type EsDimension
• type EsModel
• type EsPopulationType
• type PopulationType
• type ReleaseDateChange
• type ReleaseDateDetails
• type SearchDataImport

Types

type Dimension

type Dimension struct {
	Key      string `avro:"key"`
	AggKey   string `avro:"agg_key"`
	Name     string `avro:"name"`
	Label    string `avro:"label"`
	RawLabel string `avro:"raw_label"`
}

Dimension represents the required information for each dataset dimension: name (unique ID) and label and an aggregation key which combines name and label

type EsBulkItemResponse

type EsBulkItemResponse map[string]EsBulkItemResponseData

type EsBulkItemResponseData

type EsBulkItemResponseData struct {
	Index  string                  `json:"_index"`
	ID     string                  `json:"_id"`
	Status int                     `json:"status"`
	Error  EsBulkItemResponseError `json:"error,omitempty"`
}

EsBulkItemResponseData holds a response from ES for each item

type EsBulkItemResponseError

type EsBulkItemResponseError struct {
	ErrorType string `json:"type"`
	Reason    string `json:"reason"`
	IndexUUID string `json:"index_uuid"`
	Shard     string `json:"shard"`
	Index     string `json:"index"`
}

EsBulkItemResponseError holds an ES Error details

type EsBulkResponse

type EsBulkResponse struct {
	Took   int                  `json:"took"`
	Errors bool                 `json:"errors"`
	Items  []EsBulkItemResponse `json:"items"`
}

EsBulkResponse holds a response from ES

type EsDimension

type EsDimension struct {
	Key      string `json:"key"`
	AggKey   string `json:"agg_key"`
	Name     string `json:"name"`
	Label    string `json:"label"`
	RawLabel string `json:"raw_label"`
}

EsDimension represents a dimension in an elastic-search json

type EsModel

type EsModel struct {
	DataType        string              `json:"type"`
	URI             string              `json:"uri"`
	JobID           string              `json:"job_id"`
	SearchIndex     string              `json:"search_index"`
	CDID            string              `json:"cdid"`
	DatasetID       string              `json:"dataset_id"`
	Edition         string              `json:"edition"`
	Keywords        []string            `json:"keywords"`
	MetaDescription string              `json:"meta_description"`
	ReleaseDate     string              `json:"release_date,omitempty"`
	Summary         string              `json:"summary"`
	Title           string              `json:"title"`
	Topics          []string            `json:"topics"`
	DateChanges     []ReleaseDateChange `json:"date_changes,omitempty"`
	Cancelled       bool                `json:"cancelled"`
	Finalised       bool                `json:"finalised"`
	ProvisionalDate string              `json:"provisional_date,omitempty"`
	Published       bool                `json:"published"`
	Language        string              `json:"language,omitempty"`
	Survey          string              `json:"survey,omitempty"`
	CanonicalTopic  string              `json:"canonical_topic"`
	PopulationType  *EsPopulationType   `json:"population_type"`
	Dimensions      []EsDimension       `json:"dimensions"`
}

EsModel holds an individual content data

type EsPopulationType

type EsPopulationType struct {
	Key    string `json:"key"`
	AggKey string `json:"agg_key"`
	Name   string `json:"name"`
	Label  string `json:"label"`
}

EsPopulationType represents the population type information in an elastic-search json

type PopulationType

type PopulationType struct {
	Key    string `avro:"key"`
	AggKey string `avro:"agg_key"`
	Name   string `avro:"name"`
	Label  string `avro:"label"`
}

PopulationType represents the population type name (unique ID) and label and an aggregation key which combines name and label

type ReleaseDateChange

type ReleaseDateChange struct {
	ChangeNotice string `json:"change_notice"`
	Date         string `json:"previous_date"`
}

ReleaseDateChange represent a date change of a release

type ReleaseDateDetails

type ReleaseDateDetails struct {
	ChangeNotice string `avro:"change_notice"`
	Date         string `avro:"previous_date"`
}

ReleaseDateDetails represents a change of release date

type SearchDataImport

type SearchDataImport struct {
	UID             string               `avro:"uid"`
	URI             string               `avro:"uri"`
	Edition         string               `avro:"edition"`
	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"`
	DateChanges     []ReleaseDateDetails `avro:"date_changes"`
	Cancelled       bool                 `avro:"cancelled"`
	Finalised       bool                 `avro:"finalised"`
	ProvisionalDate string               `avro:"provisional_date"`
	CanonicalTopic  string               `avro:"canonical_topic"`
	Published       bool                 `avro:"published"`
	Language        string               `avro:"language"`
	Survey          string               `avro:"survey"`
	PopulationType  PopulationType       `avro:"population_type"`
	Dimensions      []Dimension          `avro:"dimensions"`
}

SearchDataImport provides an avro structure for a SearchDataImport Called event