clients

package
v0.9.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2025 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ClientList

type ClientList struct {
	DatasetAPI    DatasetAPIClient
	FilesAPI      FilesAPIClient
	RedirectAPI   RedirectAPIClient
	UploadService UploadServiceClient
	Zebedee       ZebedeeClient
}

ClientList holds all the API clients used by the service.

type DatasetAPIClient

type DatasetAPIClient interface {
	GetDataset(ctx context.Context, headers datasetSDK.Headers, collectionID, datasetID string) (dataset datasetModels.Dataset, err error)
}

DatasetAPIClient is an interface defining the methods for the Dataset API (github.com/ONSdigital/dp-dataset-api) client.

type FilesAPIClient

type FilesAPIClient interface {
	GetFile(ctx context.Context, path string, authToken string) (files.FileMetaData, error)
}

FilesAPIClient is an interface defining the methods for the Files API (github.com/ONSdigital/dp-files-api) client.

type RedirectAPIClient

type RedirectAPIClient interface {
	PutRedirect(ctx context.Context, options redirectSDK.Options, id string, payload redirectModels.Redirect) redirectErrors.Error
}

RedirectAPIClient is an interface defining the methods for the Redirect API (github.com/ONSdigital/dis-redirect-api) client.

type UploadServiceClient

type UploadServiceClient interface {
	Upload(ctx context.Context, fileContent io.ReadCloser, metadata upload.Metadata) error
}

UploadServiceClient is an interface defining the methods for the Upload Service (github.com/ONSdigital/dp-upload-service) client.

type ZebedeeClient

type ZebedeeClient interface {
	GetPageData(ctx context.Context, userAuthToken, collectionID, lang, path string) (m zebedee.PageData, err error)
}

ZebedeeClient is an interface defining the methods for the Zebedee (github.com/ONSdigital/zebedee) client.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL