events

Documentation

Index

• Variables
• type CantabularDatasetCategoryDimensionImport
• type CantabularDatasetInstanceComplete
• type CantabularDatasetInstanceStarted
• type DataImportComplete
• type HierarchyBuilt
• type InputFileAvailable
• type ObservationsInserted
• type SearchIndexBuilt

Variables

var CantabularDatasetCategoryDimensionImportSchema = &avro.Schema{
	Definition: cantabularDatasetCategoryDimensionImportSchema,
}

CantabularDatasetCategoryDimensionImportSchema is the avro schema for the CantabularDatasetCategoryDimensionImport event

var CantabularDatasetInstanceCompleteSchema = &avro.Schema{
	Definition: cantabularDatasetInstanceCompleteSchema,
}

CantabularDatasetInstanceCompleteSchema is the avro schema for the CantabularDatasetInstanceComplete event

var CantabularDatasetInstanceStartedSchema = &avro.Schema{
	Definition: cantabularDatasetInstanceStartedSchema,
}

CantabularDatasetInstanceStartedSchema provides an Avro schema for the CantabularDatasetInstanceStarted event

var DataImportCompleteSchema = avro.Schema{
	Definition: dataImportCompleteSchema,
}

DataImportCompleteSchema is the Avro schema for DataImportComplete

var HierarchyBuiltSchema = avro.Schema{
	Definition: hierarchyBuiltSchema,
}

HierarchyBuiltSchema is the Avro schema for HierarchyBuilt events.

var InputFileAvailableSchema = &avro.Schema{
	Definition: inputFileAvailableSchema,
}

InputFileAvailableSchema provides an Avro schema for the InputFileAvailable event.

var ObservationsInsertedSchema = avro.Schema{
	Definition: observationsInsertedSchema,
}

ObservationsInsertedSchema is the Avro schema for each observation batch inserted.

var SearchIndexBuiltSchema = &avro.Schema{
	Definition: searchIndexBuilt,
}

SearchIndexBuiltSchema is the Avro schema for each dimension hierarchy successfuly sent to elastic

Types

type CantabularDatasetCategoryDimensionImport

type CantabularDatasetCategoryDimensionImport struct {
	JobID          string `avro:"job_id"`
	InstanceID     string `avro:"instance_id"`
	DimensionID    string `avro:"dimension_id"`
	CantabularBlob string `avro:"cantabular_blob"`
	IsGeography    bool   `avro:"is_geography"`
}

CantabularDatasetCategoryDimensionImport is an event produced to trigger the import of dimension options for a given dimension from Cantabular

type CantabularDatasetInstanceComplete

type CantabularDatasetInstanceComplete struct {
	InstanceID     string `avro:"instance_id"`
	CantabularBlob string `avro:"cantabular_blob"`
}

CantabularDatasetInstanceComplete is the event produced when the dimension options have been imported and the instance has successfully been imported from Cantabular

type CantabularDatasetInstanceStarted

type CantabularDatasetInstanceStarted struct {
	RecipeID       string `avro:"recipe_id"`
	InstanceID     string `avro:"instance_id"`
	JobID          string `avro:"job_id"`
	CantabularType string `avro:"cantabular_type"`
}

CantabularDatasetInstanceStarted is an event produced when a cantabular import is triggered

type DataImportComplete

type DataImportComplete struct {
	InstanceID    string `avro:"instance_id"`
	DimensionName string `avro:"dimension_name"`
	CodeListID    string `avro:"code_list_id"`
}

DataImportComplete contains the data required for each hierarchy to be imported.

type HierarchyBuilt

type HierarchyBuilt struct {
	InstanceID    string `avro:"instance_id"`
	DimensionName string `avro:"dimension_name"`
}

HierarchyBuilt contains data related to a hierarchy that has just been built.

type InputFileAvailable

type InputFileAvailable struct {
	URL        string `avro:"file_url"`
	InstanceID string `avro:"instance_id"`
	JobID      string `avro:"job_id"`
}

InputFileAvailable is an event produced when a new input file is available to import.

type ObservationsInserted

type ObservationsInserted struct {
	ObservationsInserted int32  `avro:"observations_inserted"`
	InstanceID           string `avro:"instance_id"`
}

ObservationsInserted is the data that is output for each observation batch inserted.

type SearchIndexBuilt

type SearchIndexBuilt struct {
	InstanceID    string `avro:"instance_id"`
	DimensionName string `avro:"dimension_name"`
}

SearchIndexBuilt contains data related to a search that has just been built.