dataset

Documentation

Index

• func GetAll(dc DatasetClient, batchSize, maxWorkers int) http.HandlerFunc
• func GetEditions(dc DatasetClient) http.HandlerFunc
• func GetMetadataHandler(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc
• func GetTopics(bc BabbageClient) http.HandlerFunc
• func GetVersions(dc DatasetClient, batchSize, maxWorkers int) http.HandlerFunc
• func PutEditableMetadata(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc
• func PutMetadata(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc
• type BabbageClient
• type ClientError
• type DatasetClient
• type ZebedeeClient

Functions

func GetAll

func GetAll(dc DatasetClient, batchSize, maxWorkers int) http.HandlerFunc

GetAll returns a mapped list of all datasets

func GetEditions

func GetEditions(dc DatasetClient) http.HandlerFunc

GetEditions returns a mapped list of all editions

func GetMetadataHandler

func GetMetadataHandler(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc

GetEditMetadataHandler is a handler that wraps getEditMetadataHandler passing in addition arguments

func GetTopics

func GetTopics(bc BabbageClient) http.HandlerFunc

GetTopics returns a mapped list of topics

func GetVersions

func GetVersions(dc DatasetClient, batchSize, maxWorkers int) http.HandlerFunc

GetVersions returns a mapped list of all versions

func PutEditableMetadata

func PutEditableMetadata(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc

PutEditableMetadata updates a given list of metadata fields, agreed as being editable for both a dataset and a version object This new endpoint makes a unique call to the dataset api updating only the relevant metadata fields in a transactional way It also calls zebedee to update the collection

func PutMetadata

func PutMetadata(dc DatasetClient, zc ZebedeeClient) http.HandlerFunc

PutMetadata updates all the dataset, version and dimension object fields

Types

type BabbageClient

type BabbageClient interface {
	GetTopics(ctx context.Context, userAccessToken string) (result babbageclient.TopicsResult, err error)
}

type ClientError

type ClientError interface {
	error
	Code() int
}

ClientError implements error interface with additional code method

type DatasetClient

type DatasetClient interface {
	GetDatasetsInBatches(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, batchSize, maxWorkers int) (datasetclient.List, error)
	Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m datasetclient.DatasetDetails, err error)
	GetVersionsInBatches(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition string, batchSize, maxWorkers int) (m datasetclient.VersionsList, err error)
	GetDatasetCurrentAndNext(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m datasetclient.Dataset, err error)
	GetEdition(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition string) (m datasetclient.Edition, err error)
	GetEditions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m []datasetclient.Edition, err error)
	GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (m datasetclient.Version, err error)
	GetVersionWithHeaders(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (datasetclient.Version, datasetclient.ResponseHeaders, error)
	GetInstance(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, instanceID, ifMatch string) (i datasetclient.Instance, eTag string, err error)
	PutDataset(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string, d datasetclient.DatasetDetails) error
	PutVersion(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition, version string, v datasetclient.Version) error
	PutInstance(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, instanceID string, i datasetclient.UpdateInstance, ifMatch string) (eTag string, err error)
	PutMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition, version string, metadata datasetclient.EditableMetadata, versionEtag string) error
}

type ZebedeeClient

type ZebedeeClient interface {
	GetCollection(ctx context.Context, userAccessToken, collectionID string) (c zebedeeclient.Collection, err error)
	PutDatasetInCollection(ctx context.Context, userAccessToken, collectionID, lang, datasetID, state string) error
	PutDatasetVersionInCollection(ctx context.Context, userAccessToken, collectionID, lang, datasetID, edition, version, state string) error
}