handlers

package
v1.74.1 Latest Latest
Warning

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

 Go to latest Published: Sep 14, 2025 License: MIT Imports: 39 Imported by: 1

Documentation

Overview

Package handlers is a generated GoMock package.

Package handlers is a generated GoMock package.

Index

Constants

View Source 
const (
	DatasetTypeNomis  = "nomis"
	DatasetTypeStatic = "static"
)

Constants...

Variables

This section is empty.

Functions

func CreateCustomDataset added in v1.51.0 

func CreateCustomDataset(pc PopulationClient, zc ZebedeeClient, rend RenderClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

CreateCustomDataset will load the create custom dataset page

func CreateFilterFlexID added in v1.32.0 

func CreateFilterFlexID(fc FilterClient, dc APIClientsGoDatasetClient) http.HandlerFunc

CreateFilterFlexID creates a new filter ID for filter flex journeys

func CreateFilterFlexIDFromOutput added in v1.42.0 

func CreateFilterFlexIDFromOutput(fc FilterClient) http.HandlerFunc

CreateFilterFlexIDFromOutput creates a new filter ID for filter flex journeys from the user's filter output

func CreateFilterID 

func CreateFilterID(c FilterClient, dc APIClientsGoDatasetClient) http.HandlerFunc

CreateFilterID controls the creating of a filter idea when a new user journey is requested

func DatasetPage added in v1.34.0 

func DatasetPage(zc ZebedeeClient, rend RenderClient, fac FilesAPIClient, cacheList *cache.List) http.HandlerFunc

DatasetPage will load a legacy dataset page

func EditionsList 

func EditionsList(dc DatasetAPISdkClient, zc ZebedeeClient, tc TopicAPIClient, rend RenderClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

EditionsList will load a list of editions for a filterable dataset

func FilterOutput added in v1.34.0 

func FilterOutput(zc ZebedeeClient, fc FilterClient, pc PopulationClient, dc DatasetAPISdkClient, rend RenderClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

FilterOutput will load a filtered landing page

func FilterableLanding 

func FilterableLanding(dc DatasetAPISdkClient, pc PopulationClient, rend RenderClient, zc ZebedeeClient, tc TopicAPIClient, cfg config.Config, apiRouterVersion string) http.HandlerFunc

FilterableLanding will load a filterable landing page

func GetPublicOrPrivateTopics added in v1.70.0 

func GetPublicOrPrivateTopics(
	topicsClient TopicAPIClient,
	cfg config.Config,
	ctx context.Context,
	topicHeaders dpTopicApiSdk.Headers,
	topicID string,
) (*dpTopicApiModels.Topic, dpTopicApiSdkErrors.Error)

func LegacyLanding 

func LegacyLanding(zc ZebedeeClient, dc APIClientsGoDatasetClient, fc FilesAPIClient, rend RenderClient, cacheList *cache.List, cfg config.Config) http.HandlerFunc

LegacyLanding will load a zebedee landing page

func MetadataText 

func MetadataText(dc DatasetAPISdkClient, cfg config.Config) http.HandlerFunc

MetadataText generates a metadata text file

func PostCreateCustomDataset added in v1.51.0 

func PostCreateCustomDataset(fc FilterClient) http.HandlerFunc

PostCreateCustomDataset controls creating a custom dataset using a population type

func VersionsList 

func VersionsList(dc DatasetAPISdkClient, zc ZebedeeClient, rend RenderClient, cfg config.Config) http.HandlerFunc

VersionsList will load a list of versions for a filterable dataset

Types

type APIClientsGoDatasetClient added in v1.69.0 

type APIClientsGoDatasetClient interface {
	Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m dataset.DatasetDetails, err error)
	GetByPath(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, path string) (m dataset.DatasetDetails, err error)
	GetEditions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (m []dataset.Edition, err error)
	GetEdition(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition string) (dataset.Edition, error)
	GetVersions(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition string, q *dataset.QueryParams) (m dataset.VersionsList, err error)
	GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (m dataset.Version, err error)
	GetVersionMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (m dataset.Metadata, err error)
	GetVersionDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (m dataset.VersionDimensions, err error)
	GetOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension string, q *dataset.QueryParams) (m dataset.Options, err error)
}

Interface with methods required for a dp-api-clients-go dataset client

type ClientError 

type ClientError interface {
	Error() string
	Code() int
}

ClientError is an interface that can be used to retrieve the status code if a client has errored

type DatasetAPISdkClient added in v1.69.0 

type DatasetAPISdkClient interface {
	GetDataset(ctx context.Context, headers dpDatasetApiSdk.Headers, collectionID, datasetID string) (m dpDatasetApiModels.Dataset, err error)
	GetDatasetByPath(ctx context.Context, headers dpDatasetApiSdk.Headers, path string) (m dpDatasetApiModels.Dataset, err error)
	GetEditions(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID string, q *dpDatasetApiSdk.QueryParams) (m dpDatasetApiSdk.EditionsList, err error)
	GetEdition(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, edition string) (dpDatasetApiModels.Edition, error)
	GetVersions(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID string, q *dpDatasetApiSdk.QueryParams) (m dpDatasetApiSdk.VersionsList, err error)
	GetVersion(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID, versionID string) (m dpDatasetApiModels.Version, err error)
	GetVersionV2(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID, versionID string) (m dpDatasetApiModels.Version, err error)
	GetVersionMetadata(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID, versionID string) (m dpDatasetApiModels.Metadata, err error)
	GetVersionDimensions(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID, versionID string) (m dpDatasetApiSdk.VersionDimensionsList, err error)
	GetVersionDimensionOptions(ctx context.Context, headers dpDatasetApiSdk.Headers, datasetID, editionID, versionID, dimensionID string, q *dpDatasetApiSdk.QueryParams) (m dpDatasetApiSdk.VersionDimensionOptionsList, err error)
}

Interface with methods required for a dp-dataset-api/sdk dataset client

type FilesAPIClient added in v1.33.0 

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

FilesAPIClient is an interface with methods required for getting metadata from Files API

type FilterClient 

type FilterClient interface {
	CreateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, names []string) (filterID, eTag string, err error)
	CreateCustomFilter(ctx context.Context, userAuthToken, serviceAuthToken, populationType string) (filterID string, err error)
	CreateFlexibleBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, dimensions []filter.ModelDimension, populationType string) (filterID, eTag string, err error)
	GetOutput(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID string) (m filter.Model, err error)
	GetDimensionOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string, q *filter.QueryParams) (opts filter.DimensionOptions, eTag string, err error)
	CreateFlexibleBlueprintCustom(ctx context.Context, uAuthToken, svcAuthToken, dlServiceToken string, req filter.CreateFlexBlueprintCustomRequest) (filterID, eTag string, err error)
}

FilterClient is an interface with the methods required for a filter client

type MockAPIClientsGoDatasetClient added in v1.69.0 

type MockAPIClientsGoDatasetClient struct {
	// contains filtered or unexported fields
}

MockAPIClientsGoDatasetClient is a mock of APIClientsGoDatasetClient interface.

func NewMockAPIClientsGoDatasetClient added in v1.69.0 

func NewMockAPIClientsGoDatasetClient(ctrl *gomock.Controller) *MockAPIClientsGoDatasetClient

NewMockAPIClientsGoDatasetClient creates a new mock instance.

func (*MockAPIClientsGoDatasetClient) EXPECT added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) EXPECT() *MockAPIClientsGoDatasetClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockAPIClientsGoDatasetClient) Get added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) Get(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) (dataset.DatasetDetails, error)

Get mocks base method.

func (*MockAPIClientsGoDatasetClient) GetByPath added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetByPath(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, path string) (dataset.DatasetDetails, error)

GetByPath mocks base method.

func (*MockAPIClientsGoDatasetClient) GetEdition added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetEdition(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID, edition string) (dataset.Edition, error)

GetEdition mocks base method.

func (*MockAPIClientsGoDatasetClient) GetEditions added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetEditions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, datasetID string) ([]dataset.Edition, error)

GetEditions mocks base method.

func (*MockAPIClientsGoDatasetClient) GetOptions added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension string, q *dataset.QueryParams) (dataset.Options, error)

GetOptions mocks base method.

func (*MockAPIClientsGoDatasetClient) GetVersion added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetVersion(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version string) (dataset.Version, error)

GetVersion mocks base method.

func (*MockAPIClientsGoDatasetClient) GetVersionDimensions added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetVersionDimensions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (dataset.VersionDimensions, error)

GetVersionDimensions mocks base method.

func (*MockAPIClientsGoDatasetClient) GetVersionMetadata added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetVersionMetadata(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, id, edition, version string) (dataset.Metadata, error)

GetVersionMetadata mocks base method.

func (*MockAPIClientsGoDatasetClient) GetVersions added in v1.69.0 

func (m *MockAPIClientsGoDatasetClient) GetVersions(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition string, q *dataset.QueryParams) (dataset.VersionsList, error)

GetVersions mocks base method.

type MockAPIClientsGoDatasetClientMockRecorder added in v1.69.0 

type MockAPIClientsGoDatasetClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockAPIClientsGoDatasetClientMockRecorder is the mock recorder for MockAPIClientsGoDatasetClient.

func (*MockAPIClientsGoDatasetClientMockRecorder) Get added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) Get(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID interface{}) *gomock.Call

Get indicates an expected call of Get.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetByPath added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetByPath(ctx, userAuthToken, serviceAuthToken, collectionID, path interface{}) *gomock.Call

GetByPath indicates an expected call of GetByPath.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetEdition added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetEdition(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID, edition interface{}) *gomock.Call

GetEdition indicates an expected call of GetEdition.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetEditions added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetEditions(ctx, userAuthToken, serviceAuthToken, collectionID, datasetID interface{}) *gomock.Call

GetEditions indicates an expected call of GetEditions.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetOptions added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetOptions(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version, dimension, q interface{}) *gomock.Call

GetOptions indicates an expected call of GetOptions.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetVersion added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetVersion(ctx, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, version interface{}) *gomock.Call

GetVersion indicates an expected call of GetVersion.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetVersionDimensions added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetVersionDimensions(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version interface{}) *gomock.Call

GetVersionDimensions indicates an expected call of GetVersionDimensions.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetVersionMetadata added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetVersionMetadata(ctx, userAuthToken, serviceAuthToken, collectionID, id, edition, version interface{}) *gomock.Call

GetVersionMetadata indicates an expected call of GetVersionMetadata.

func (*MockAPIClientsGoDatasetClientMockRecorder) GetVersions added in v1.69.0 

func (mr *MockAPIClientsGoDatasetClientMockRecorder) GetVersions(ctx, userAuthToken, serviceAuthToken, downloadServiceAuthToken, collectionID, datasetID, edition, q interface{}) *gomock.Call

GetVersions indicates an expected call of GetVersions.

type MockClientError 

type MockClientError struct {
	// contains filtered or unexported fields
}

MockClientError is a mock of ClientError interface.

func NewMockClientError 

func NewMockClientError(ctrl *gomock.Controller) *MockClientError

NewMockClientError creates a new mock instance.

func (*MockClientError) Code 

func (m *MockClientError) Code() int

Code mocks base method.

func (*MockClientError) EXPECT 

func (m *MockClientError) EXPECT() *MockClientErrorMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClientError) Error 

func (m *MockClientError) Error() string

Error mocks base method.

type MockClientErrorMockRecorder 

type MockClientErrorMockRecorder struct {
	// contains filtered or unexported fields
}

MockClientErrorMockRecorder is the mock recorder for MockClientError.

func (*MockClientErrorMockRecorder) Code 

func (mr *MockClientErrorMockRecorder) Code() *gomock.Call

Code indicates an expected call of Code.

func (*MockClientErrorMockRecorder) Error 

func (mr *MockClientErrorMockRecorder) Error() *gomock.Call

Error indicates an expected call of Error.

type MockDatasetAPISdkClient added in v1.69.0 

type MockDatasetAPISdkClient struct {
	// contains filtered or unexported fields
}

MockDatasetAPISdkClient is a mock of DatasetAPISdkClient interface.

func NewMockDatasetAPISdkClient added in v1.69.0 

func NewMockDatasetAPISdkClient(ctrl *gomock.Controller) *MockDatasetAPISdkClient

NewMockDatasetAPISdkClient creates a new mock instance.

func (*MockDatasetAPISdkClient) EXPECT added in v1.69.0 

func (m *MockDatasetAPISdkClient) EXPECT() *MockDatasetAPISdkClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockDatasetAPISdkClient) GetDataset added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetDataset(ctx context.Context, headers sdk.Headers, collectionID, datasetID string) (models.Dataset, error)

GetDataset mocks base method.

func (*MockDatasetAPISdkClient) GetDatasetByPath added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetDatasetByPath(ctx context.Context, headers sdk.Headers, path string) (models.Dataset, error)

GetDatasetByPath mocks base method.

func (*MockDatasetAPISdkClient) GetEdition added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetEdition(ctx context.Context, headers sdk.Headers, datasetID, edition string) (models.Edition, error)

GetEdition mocks base method.

func (*MockDatasetAPISdkClient) GetEditions added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetEditions(ctx context.Context, headers sdk.Headers, datasetID string, q *sdk.QueryParams) (sdk.EditionsList, error)

GetEditions mocks base method.

func (*MockDatasetAPISdkClient) GetVersion added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetVersion(ctx context.Context, headers sdk.Headers, datasetID, editionID, versionID string) (models.Version, error)

GetVersion mocks base method.

func (*MockDatasetAPISdkClient) GetVersionDimensionOptions added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetVersionDimensionOptions(ctx context.Context, headers sdk.Headers, datasetID, editionID, versionID, dimensionID string, q *sdk.QueryParams) (sdk.VersionDimensionOptionsList, error)

GetVersionDimensionOptions mocks base method.

func (*MockDatasetAPISdkClient) GetVersionDimensions added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetVersionDimensions(ctx context.Context, headers sdk.Headers, datasetID, editionID, versionID string) (sdk.VersionDimensionsList, error)

GetVersionDimensions mocks base method.

func (*MockDatasetAPISdkClient) GetVersionMetadata added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetVersionMetadata(ctx context.Context, headers sdk.Headers, datasetID, editionID, versionID string) (models.Metadata, error)

GetVersionMetadata mocks base method.

func (*MockDatasetAPISdkClient) GetVersionV2 added in v1.74.0 

func (m *MockDatasetAPISdkClient) GetVersionV2(ctx context.Context, headers sdk.Headers, datasetID, editionID, versionID string) (models.Version, error)

GetVersionV2 mocks base method.

func (*MockDatasetAPISdkClient) GetVersions added in v1.69.0 

func (m *MockDatasetAPISdkClient) GetVersions(ctx context.Context, headers sdk.Headers, datasetID, editionID string, q *sdk.QueryParams) (sdk.VersionsList, error)

GetVersions mocks base method.

type MockDatasetAPISdkClientMockRecorder added in v1.69.0 

type MockDatasetAPISdkClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockDatasetAPISdkClientMockRecorder is the mock recorder for MockDatasetAPISdkClient.

func (*MockDatasetAPISdkClientMockRecorder) GetDataset added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetDataset(ctx, headers, collectionID, datasetID interface{}) *gomock.Call

GetDataset indicates an expected call of GetDataset.

func (*MockDatasetAPISdkClientMockRecorder) GetDatasetByPath added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetDatasetByPath(ctx, headers, path interface{}) *gomock.Call

GetDatasetByPath indicates an expected call of GetDatasetByPath.

func (*MockDatasetAPISdkClientMockRecorder) GetEdition added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetEdition(ctx, headers, datasetID, edition interface{}) *gomock.Call

GetEdition indicates an expected call of GetEdition.

func (*MockDatasetAPISdkClientMockRecorder) GetEditions added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetEditions(ctx, headers, datasetID, q interface{}) *gomock.Call

GetEditions indicates an expected call of GetEditions.

func (*MockDatasetAPISdkClientMockRecorder) GetVersion added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersion(ctx, headers, datasetID, editionID, versionID interface{}) *gomock.Call

GetVersion indicates an expected call of GetVersion.

func (*MockDatasetAPISdkClientMockRecorder) GetVersionDimensionOptions added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersionDimensionOptions(ctx, headers, datasetID, editionID, versionID, dimensionID, q interface{}) *gomock.Call

GetVersionDimensionOptions indicates an expected call of GetVersionDimensionOptions.

func (*MockDatasetAPISdkClientMockRecorder) GetVersionDimensions added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersionDimensions(ctx, headers, datasetID, editionID, versionID interface{}) *gomock.Call

GetVersionDimensions indicates an expected call of GetVersionDimensions.

func (*MockDatasetAPISdkClientMockRecorder) GetVersionMetadata added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersionMetadata(ctx, headers, datasetID, editionID, versionID interface{}) *gomock.Call

GetVersionMetadata indicates an expected call of GetVersionMetadata.

func (*MockDatasetAPISdkClientMockRecorder) GetVersionV2 added in v1.74.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersionV2(ctx, headers, datasetID, editionID, versionID interface{}) *gomock.Call

GetVersionV2 indicates an expected call of GetVersionV2.

func (*MockDatasetAPISdkClientMockRecorder) GetVersions added in v1.69.0 

func (mr *MockDatasetAPISdkClientMockRecorder) GetVersions(ctx, headers, datasetID, editionID, q interface{}) *gomock.Call

GetVersions indicates an expected call of GetVersions.

type MockFilesAPIClient added in v1.33.0 

type MockFilesAPIClient struct {
	// contains filtered or unexported fields
}

MockFilesAPIClient is a mock of FilesAPIClient interface.

func NewMockFilesAPIClient added in v1.33.0 

func NewMockFilesAPIClient(ctrl *gomock.Controller) *MockFilesAPIClient

NewMockFilesAPIClient creates a new mock instance.

func (*MockFilesAPIClient) EXPECT added in v1.33.0 

func (m *MockFilesAPIClient) EXPECT() *MockFilesAPIClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockFilesAPIClient) GetFile added in v1.33.0 

func (m *MockFilesAPIClient) GetFile(ctx context.Context, path, authToken string) (files.FileMetaData, error)

GetFile mocks base method.

type MockFilesAPIClientMockRecorder added in v1.33.0 

type MockFilesAPIClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockFilesAPIClientMockRecorder is the mock recorder for MockFilesAPIClient.

func (*MockFilesAPIClientMockRecorder) GetFile added in v1.33.0 

func (mr *MockFilesAPIClientMockRecorder) GetFile(ctx, path, authToken interface{}) *gomock.Call

GetFile indicates an expected call of GetFile.

type MockFilterClient 

type MockFilterClient struct {
	// contains filtered or unexported fields
}

MockFilterClient is a mock of FilterClient interface.

func NewMockFilterClient 

func NewMockFilterClient(ctrl *gomock.Controller) *MockFilterClient

NewMockFilterClient creates a new mock instance.

func (*MockFilterClient) CreateBlueprint 

func (m *MockFilterClient) CreateBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, names []string) (string, string, error)

CreateBlueprint mocks base method.

func (*MockFilterClient) CreateCustomFilter added in v1.51.0 

func (m *MockFilterClient) CreateCustomFilter(ctx context.Context, userAuthToken, serviceAuthToken, populationType string) (string, error)

CreateCustomFilter mocks base method.

func (*MockFilterClient) CreateFlexibleBlueprint added in v1.32.0 

func (m *MockFilterClient) CreateFlexibleBlueprint(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version string, dimensions []filter.ModelDimension, populationType string) (string, string, error)

CreateFlexibleBlueprint mocks base method.

func (*MockFilterClient) CreateFlexibleBlueprintCustom added in v1.51.0 

func (m *MockFilterClient) CreateFlexibleBlueprintCustom(ctx context.Context, uAuthToken, svcAuthToken, dlServiceToken string, req filter.CreateFlexBlueprintCustomRequest) (string, string, error)

CreateFlexibleBlueprintCustom mocks base method.

func (*MockFilterClient) EXPECT 

func (m *MockFilterClient) EXPECT() *MockFilterClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockFilterClient) GetDimensionOptions added in v1.40.0 

func (m *MockFilterClient) GetDimensionOptions(ctx context.Context, userAuthToken, serviceAuthToken, collectionID, filterID, name string, q *filter.QueryParams) (filter.DimensionOptions, string, error)

GetDimensionOptions mocks base method.

func (*MockFilterClient) GetOutput added in v1.34.0 

func (m *MockFilterClient) GetOutput(ctx context.Context, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID string) (filter.Model, error)

GetOutput mocks base method.

type MockFilterClientMockRecorder 

type MockFilterClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockFilterClientMockRecorder is the mock recorder for MockFilterClient.

func (*MockFilterClientMockRecorder) CreateBlueprint 

func (mr *MockFilterClientMockRecorder) CreateBlueprint(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version, names interface{}) *gomock.Call

CreateBlueprint indicates an expected call of CreateBlueprint.

func (*MockFilterClientMockRecorder) CreateCustomFilter added in v1.51.0 

func (mr *MockFilterClientMockRecorder) CreateCustomFilter(ctx, userAuthToken, serviceAuthToken, populationType interface{}) *gomock.Call

CreateCustomFilter indicates an expected call of CreateCustomFilter.

func (*MockFilterClientMockRecorder) CreateFlexibleBlueprint added in v1.32.0 

func (mr *MockFilterClientMockRecorder) CreateFlexibleBlueprint(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, datasetID, edition, version, dimensions, populationType interface{}) *gomock.Call

CreateFlexibleBlueprint indicates an expected call of CreateFlexibleBlueprint.

func (*MockFilterClientMockRecorder) CreateFlexibleBlueprintCustom added in v1.51.0 

func (mr *MockFilterClientMockRecorder) CreateFlexibleBlueprintCustom(ctx, uAuthToken, svcAuthToken, dlServiceToken, req interface{}) *gomock.Call

CreateFlexibleBlueprintCustom indicates an expected call of CreateFlexibleBlueprintCustom.

func (*MockFilterClientMockRecorder) GetDimensionOptions added in v1.40.0 

func (mr *MockFilterClientMockRecorder) GetDimensionOptions(ctx, userAuthToken, serviceAuthToken, collectionID, filterID, name, q interface{}) *gomock.Call

GetDimensionOptions indicates an expected call of GetDimensionOptions.

func (*MockFilterClientMockRecorder) GetOutput added in v1.34.0 

func (mr *MockFilterClientMockRecorder) GetOutput(ctx, userAuthToken, serviceAuthToken, downloadServiceToken, collectionID, filterOutputID interface{}) *gomock.Call

GetOutput indicates an expected call of GetOutput.

type MockPopulationClient added in v1.38.0 

type MockPopulationClient struct {
	// contains filtered or unexported fields
}

MockPopulationClient is a mock of PopulationClient interface.

func NewMockPopulationClient added in v1.38.0 

func NewMockPopulationClient(ctrl *gomock.Controller) *MockPopulationClient

NewMockPopulationClient creates a new mock instance.

func (*MockPopulationClient) EXPECT added in v1.38.0 

func (m *MockPopulationClient) EXPECT() *MockPopulationClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockPopulationClient) GetArea added in v1.42.0 

func (m *MockPopulationClient) GetArea(ctx context.Context, input population.GetAreaInput) (population.GetAreaResponse, error)

GetArea mocks base method.

func (*MockPopulationClient) GetAreas added in v1.38.0 

func (m *MockPopulationClient) GetAreas(ctx context.Context, input population.GetAreasInput) (population.GetAreasResponse, error)

GetAreas mocks base method.

func (*MockPopulationClient) GetBlockedAreaCount added in v1.50.0 

func (m *MockPopulationClient) GetBlockedAreaCount(ctx context.Context, input population.GetBlockedAreaCountInput) (*cantabular.GetBlockedAreaCountResult, error)

GetBlockedAreaCount mocks base method.

func (*MockPopulationClient) GetCategorisations added in v1.50.0 

func (m *MockPopulationClient) GetCategorisations(ctx context.Context, input population.GetCategorisationsInput) (population.GetCategorisationsResponse, error)

GetCategorisations mocks base method.

func (*MockPopulationClient) GetDimensionCategories added in v1.50.0 

func (m *MockPopulationClient) GetDimensionCategories(ctx context.Context, input population.GetDimensionCategoryInput) (population.GetDimensionCategoriesResponse, error)

GetDimensionCategories mocks base method.

func (*MockPopulationClient) GetDimensionsDescription added in v1.49.0 

func (m *MockPopulationClient) GetDimensionsDescription(ctx context.Context, input population.GetDimensionsDescriptionInput) (population.GetDimensionsResponse, error)

GetDimensionsDescription mocks base method.

func (*MockPopulationClient) GetPopulationType added in v1.54.0 

func (m *MockPopulationClient) GetPopulationType(ctx context.Context, input population.GetPopulationTypeInput) (population.GetPopulationTypeResponse, error)

GetPopulationType mocks base method.

func (*MockPopulationClient) GetPopulationTypeMetadata added in v1.51.0 

func (m *MockPopulationClient) GetPopulationTypeMetadata(ctx context.Context, input population.GetPopulationTypeMetadataInput) (population.GetPopulationTypeMetadataResponse, error)

GetPopulationTypeMetadata mocks base method.

func (*MockPopulationClient) GetPopulationTypes added in v1.51.0 

func (m *MockPopulationClient) GetPopulationTypes(ctx context.Context, input population.GetPopulationTypesInput) (population.GetPopulationTypesResponse, error)

GetPopulationTypes mocks base method.

type MockPopulationClientMockRecorder added in v1.38.0 

type MockPopulationClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockPopulationClientMockRecorder is the mock recorder for MockPopulationClient.

func (*MockPopulationClientMockRecorder) GetArea added in v1.42.0 

func (mr *MockPopulationClientMockRecorder) GetArea(ctx, input interface{}) *gomock.Call

GetArea indicates an expected call of GetArea.

func (*MockPopulationClientMockRecorder) GetAreas added in v1.38.0 

func (mr *MockPopulationClientMockRecorder) GetAreas(ctx, input interface{}) *gomock.Call

GetAreas indicates an expected call of GetAreas.

func (*MockPopulationClientMockRecorder) GetBlockedAreaCount added in v1.50.0 

func (mr *MockPopulationClientMockRecorder) GetBlockedAreaCount(ctx, input interface{}) *gomock.Call

GetBlockedAreaCount indicates an expected call of GetBlockedAreaCount.

func (*MockPopulationClientMockRecorder) GetCategorisations added in v1.50.0 

func (mr *MockPopulationClientMockRecorder) GetCategorisations(ctx, input interface{}) *gomock.Call

GetCategorisations indicates an expected call of GetCategorisations.

func (*MockPopulationClientMockRecorder) GetDimensionCategories added in v1.50.0 

func (mr *MockPopulationClientMockRecorder) GetDimensionCategories(ctx, input interface{}) *gomock.Call

GetDimensionCategories indicates an expected call of GetDimensionCategories.

func (*MockPopulationClientMockRecorder) GetDimensionsDescription added in v1.49.0 

func (mr *MockPopulationClientMockRecorder) GetDimensionsDescription(ctx, input interface{}) *gomock.Call

GetDimensionsDescription indicates an expected call of GetDimensionsDescription.

func (*MockPopulationClientMockRecorder) GetPopulationType added in v1.54.0 

func (mr *MockPopulationClientMockRecorder) GetPopulationType(ctx, input interface{}) *gomock.Call

GetPopulationType indicates an expected call of GetPopulationType.

func (*MockPopulationClientMockRecorder) GetPopulationTypeMetadata added in v1.51.0 

func (mr *MockPopulationClientMockRecorder) GetPopulationTypeMetadata(ctx, input interface{}) *gomock.Call

GetPopulationTypeMetadata indicates an expected call of GetPopulationTypeMetadata.

func (*MockPopulationClientMockRecorder) GetPopulationTypes added in v1.51.0 

func (mr *MockPopulationClientMockRecorder) GetPopulationTypes(ctx, input interface{}) *gomock.Call

GetPopulationTypes indicates an expected call of GetPopulationTypes.

type MockRenderClient 

type MockRenderClient struct {
	// contains filtered or unexported fields
}

MockRenderClient is a mock of RenderClient interface.

func NewMockRenderClient 

func NewMockRenderClient(ctrl *gomock.Controller) *MockRenderClient

NewMockRenderClient creates a new mock instance.

func (*MockRenderClient) BuildPage added in v1.23.0 

func (m *MockRenderClient) BuildPage(w io.Writer, pageModel interface{}, templateName string)

BuildPage mocks base method.

func (*MockRenderClient) EXPECT 

func (m *MockRenderClient) EXPECT() *MockRenderClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockRenderClient) NewBasePageModel added in v1.23.0 

func (m *MockRenderClient) NewBasePageModel() model.Page

NewBasePageModel mocks base method.

type MockRenderClientMockRecorder 

type MockRenderClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockRenderClientMockRecorder is the mock recorder for MockRenderClient.

func (*MockRenderClientMockRecorder) BuildPage added in v1.23.0 

func (mr *MockRenderClientMockRecorder) BuildPage(w, pageModel, templateName interface{}) *gomock.Call

BuildPage indicates an expected call of BuildPage.

func (*MockRenderClientMockRecorder) NewBasePageModel added in v1.23.0 

func (mr *MockRenderClientMockRecorder) NewBasePageModel() *gomock.Call

NewBasePageModel indicates an expected call of NewBasePageModel.

type MockTopicAPIClient added in v1.70.0 

type MockTopicAPIClient struct {
	// contains filtered or unexported fields
}

MockTopicAPIClient is a mock of TopicAPIClient interface.

func NewMockTopicAPIClient added in v1.70.0 

func NewMockTopicAPIClient(ctrl *gomock.Controller) *MockTopicAPIClient

NewMockTopicAPIClient creates a new mock instance.

func (*MockTopicAPIClient) EXPECT added in v1.70.0 

func (m *MockTopicAPIClient) EXPECT() *MockTopicAPIClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockTopicAPIClient) GetTopicPrivate added in v1.70.0 

func (m *MockTopicAPIClient) GetTopicPrivate(ctx context.Context, headers sdk0.Headers, id string) (*models0.TopicResponse, errors.Error)

GetTopicPrivate mocks base method.

func (*MockTopicAPIClient) GetTopicPublic added in v1.70.0 

func (m *MockTopicAPIClient) GetTopicPublic(ctx context.Context, headers sdk0.Headers, id string) (*models0.Topic, errors.Error)

GetTopicPublic mocks base method.

type MockTopicAPIClientMockRecorder added in v1.70.0 

type MockTopicAPIClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockTopicAPIClientMockRecorder is the mock recorder for MockTopicAPIClient.

func (*MockTopicAPIClientMockRecorder) GetTopicPrivate added in v1.70.0 

func (mr *MockTopicAPIClientMockRecorder) GetTopicPrivate(ctx, headers, id interface{}) *gomock.Call

GetTopicPrivate indicates an expected call of GetTopicPrivate.

func (*MockTopicAPIClientMockRecorder) GetTopicPublic added in v1.70.0 

func (mr *MockTopicAPIClientMockRecorder) GetTopicPublic(ctx, headers, id interface{}) *gomock.Call

GetTopicPublic indicates an expected call of GetTopicPublic.

type MockZebedeeClient 

type MockZebedeeClient struct {
	// contains filtered or unexported fields
}

MockZebedeeClient is a mock of ZebedeeClient interface.

func NewMockZebedeeClient 

func NewMockZebedeeClient(ctrl *gomock.Controller) *MockZebedeeClient

NewMockZebedeeClient creates a new mock instance.

func (*MockZebedeeClient) EXPECT 

func (m *MockZebedeeClient) EXPECT() *MockZebedeeClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockZebedeeClient) Get 

func (m *MockZebedeeClient) Get(ctx context.Context, userAccessToken, path string) ([]byte, error)

Get mocks base method.

func (*MockZebedeeClient) GetBreadcrumb 

func (m *MockZebedeeClient) GetBreadcrumb(ctx context.Context, userAccessToken, collectionID, lang, path string) ([]zebedee.Breadcrumb, error)

GetBreadcrumb mocks base method.

func (*MockZebedeeClient) GetDataset 

func (m *MockZebedeeClient) GetDataset(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.Dataset, error)

GetDataset mocks base method.

func (*MockZebedeeClient) GetDatasetLandingPage 

func (m *MockZebedeeClient) GetDatasetLandingPage(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.DatasetLandingPage, error)

GetDatasetLandingPage mocks base method.

func (*MockZebedeeClient) GetHomepageContent added in v1.30.0 

func (m *MockZebedeeClient) GetHomepageContent(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.HomepageContent, error)

GetHomepageContent mocks base method.

type MockZebedeeClientMockRecorder 

type MockZebedeeClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockZebedeeClientMockRecorder is the mock recorder for MockZebedeeClient.

func (*MockZebedeeClientMockRecorder) Get 

func (mr *MockZebedeeClientMockRecorder) Get(ctx, userAccessToken, path interface{}) *gomock.Call

Get indicates an expected call of Get.

func (*MockZebedeeClientMockRecorder) GetBreadcrumb 

func (mr *MockZebedeeClientMockRecorder) GetBreadcrumb(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetBreadcrumb indicates an expected call of GetBreadcrumb.

func (*MockZebedeeClientMockRecorder) GetDataset 

func (mr *MockZebedeeClientMockRecorder) GetDataset(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetDataset indicates an expected call of GetDataset.

func (*MockZebedeeClientMockRecorder) GetDatasetLandingPage 

func (mr *MockZebedeeClientMockRecorder) GetDatasetLandingPage(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetDatasetLandingPage indicates an expected call of GetDatasetLandingPage.

func (*MockZebedeeClientMockRecorder) GetHomepageContent added in v1.30.0 

func (mr *MockZebedeeClientMockRecorder) GetHomepageContent(ctx, userAccessToken, collectionID, lang, path interface{}) *gomock.Call

GetHomepageContent indicates an expected call of GetHomepageContent.

type PopulationClient added in v1.38.0 

type PopulationClient interface {
	GetArea(ctx context.Context, input population.GetAreaInput) (population.GetAreaResponse, error)
	GetAreas(ctx context.Context, input population.GetAreasInput) (population.GetAreasResponse, error)
	GetBlockedAreaCount(ctx context.Context, input population.GetBlockedAreaCountInput) (*cantabular.GetBlockedAreaCountResult, error)
	GetDimensionCategories(ctx context.Context, input population.GetDimensionCategoryInput) (population.GetDimensionCategoriesResponse, error)
	GetDimensionsDescription(ctx context.Context, input population.GetDimensionsDescriptionInput) (population.GetDimensionsResponse, error)
	GetCategorisations(ctx context.Context, input population.GetCategorisationsInput) (population.GetCategorisationsResponse, error)
	GetPopulationType(ctx context.Context, input population.GetPopulationTypeInput) (population.GetPopulationTypeResponse, error)
	GetPopulationTypes(ctx context.Context, input population.GetPopulationTypesInput) (population.GetPopulationTypesResponse, error)
	GetPopulationTypeMetadata(ctx context.Context, input population.GetPopulationTypeMetadataInput) (population.GetPopulationTypeMetadataResponse, error)
}

PopulationClient is an interface with methods required for a population client

type RenderClient 

type RenderClient interface {
	BuildPage(w io.Writer, pageModel interface{}, templateName string)
	NewBasePageModel() coreModel.Page
}

RenderClient is an interface with methods for require for rendering a template

type TopicAPIClient added in v1.70.0 

type TopicAPIClient interface {
	GetTopicPublic(ctx context.Context, headers dpTopicApiSdk.Headers, id string) (*dpTopicApiModels.Topic, dpTopicApiErrors.Error)
	GetTopicPrivate(ctx context.Context, headers dpTopicApiSdk.Headers, id string) (*dpTopicApiModels.TopicResponse, dpTopicApiErrors.Error)
}

TopicClient is an interface with methods required for a topic client

type ZebedeeClient 

type ZebedeeClient interface {
	GetBreadcrumb(ctx context.Context, userAccessToken, collectionID, lang, path string) ([]zebedee.Breadcrumb, error)
	Get(ctx context.Context, userAccessToken, path string) ([]byte, error)
	GetDatasetLandingPage(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.DatasetLandingPage, error)
	GetDataset(ctx context.Context, userAccessToken, collectionID, lang, path string) (zebedee.Dataset, error)
	GetHomepageContent(ctx context.Context, userAccessToken, collectionID, lang, path string) (m zebedee.HomepageContent, err error)
}

ZebedeeClient is an interface for zebedee client

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.