dataset

Mar 30, 2023

Changes in this version

type Client

+ func (c *Client) PutMetadata(ctx context.Context, ...) error

+ type EditableMetadata struct

+ Alerts *[]Alert

+ CanonicalTopic string

+ Contacts []Contact

+ Description string

+ Dimensions []VersionDimension

+ Keywords []string

+ LatestChanges *[]Change

+ License string

+ Methodologies []Methodology

+ NationalStatistic *bool

+ NextRelease string

+ Publications []Publication

+ QMI *Publication

+ RelatedContent []GeneralDetails

+ RelatedDatasets []RelatedDataset

+ ReleaseDate string

+ ReleaseFrequency string

+ Subtopics []string

+ Survey string

+ Title string

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

Mar 24, 2023

Changes in this version

type Client

+ func (c *Client) GetVersionWithHeaders(ctx context.Context, ...) (v Version, h ResponseHeaders, err error)

+ type ResponseHeaders struct

+ ETag string

Nov 7, 2022

Changes in this version

type NewInstance

+ LowestGeography string

type Version

+ LowestGeography string

Nov 3, 2022

Changes in this version

type DatasetDetails

+ LowestGeography string

Oct 26, 2022

Changes in this version

type VersionDimension

+ QualityStatementText string

+ QualityStatementURL string

Oct 24, 2022

Changes in this version

type DatasetDetails

+ RelatedContent *[]GeneralDetails

+ type GeneralDetails struct

+ Description string

+ HRef string

+ Title string

Oct 20, 2022

Changes in this version

type DatasetDetails

+ Subtopics []string

+ Survey string

Oct 19, 2022

Changes in this version

type DatasetDetails

+ VersionsList VersionsList

Sep 29, 2022

Changes in this version

type DatasetDetails

+ CanonicalTopic *Topic

+ SubTopics []Topic

+ type Topic struct

+ ID string

+ Title string

Aug 30, 2022

Changes in this version

type Metadata

+ func (m *Metadata) UnmarshalJSON(js []byte) error

Jun 7, 2022

Changes in this version

type QueryParams

+ IsBasedOn string

May 10, 2022

Changes in this version

type Client

+ func (c *Client) GetVersionMetadataSelection(ctx context.Context, req GetVersionMetadataSelectionInput) (*Metadata, error)

+ type GetVersionMetadataSelectionInput struct

+ CollectionID string

+ DatasetID string

+ Dimensions []string

+ Edition string

+ ServiceAuthToken string

+ UserAuthToken string

+ Version string

Apr 20, 2022

Changes in this version

type VersionDimension

+ IsAreaType bool

Mar 17, 2022

Changes in this version

type Client

+ func (c *Client) GetFullEditionsDetails(ctx context.Context, ...) (m []EditionsDetails, err error)

+ type EditionItems struct

+ Items []EditionsDetails

+ type EditionsDetails struct

+ Current Edition

+ ID string

+ Next Edition

Feb 3, 2022

Changes in this version

type DatasetDetails

+ IsBasedOn *IsBasedOn

Dec 17, 2021

Changes in this version

type Metadata

+ DatasetLinks Links

Nov 11, 2021

Changes in this version

type Version

+ IsBasedOn *IsBasedOn

Sep 22, 2021

Changes in this version

+ type OptionUpdate struct

+ Name string

+ NodeID string

+ Option string

+ Order *int

Aug 31, 2021

Changes in this version

type Client

+ func (c *Client) PatchInstanceDimensions(ctx context.Context, serviceAuthToken, instanceID string, data []*OptionPost, ...) (eTag string, err error)

Aug 12, 2021

Changes in this version

+ var ErrBatchETagMismatch = errors.New("ETag value changed from one batch to another")

+ var MaxIDs = func() int

+ type Alert struct

+ Date string

+ Description string

+ Type string

+ type BuildHierarchyTask struct

+ CodeListID string

+ DimensionName string

+ State string

+ type BuildSearchIndexTask struct

+ DimensionName string

+ State string

+ type Change struct

+ Description string

+ Name string

+ Type string

+ type Client struct

+ func NewAPIClient(datasetAPIURL string) *Client

+ func NewAPIClientWithMaxRetries(datasetAPIURL string, maxRetries int) *Client

+ func NewWithHealthClient(hcCli *healthcheck.Client) *Client

+ func (c *Client) Checker(ctx context.Context, check *health.CheckState) error

+ func (c *Client) Get(ctx context.Context, ...) (m DatasetDetails, err error)

+ func (c *Client) GetByPath(ctx context.Context, ...) (m DatasetDetails, err error)

+ func (c *Client) GetDatasetCurrentAndNext(ctx context.Context, ...) (m Dataset, err error)

+ func (c *Client) GetDatasets(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (m List, err error)

+ func (c *Client) GetDatasetsBatchProcess(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) error

+ func (c *Client) GetDatasetsInBatches(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (datasets List, err error)

+ func (c *Client) GetEdition(ctx context.Context, ...) (m Edition, err error)

+ func (c *Client) GetEditions(ctx context.Context, ...) (m []Edition, err error)

+ func (c *Client) GetInstance(ctx context.Context, ...) (m Instance, eTag string, err error)

+ func (c *Client) GetInstanceBytes(ctx context.Context, ...) (b []byte, eTag string, err error)

+ func (c *Client) GetInstanceDimensions(ctx context.Context, serviceAuthToken, instanceID string, q *QueryParams, ...) (m Dimensions, eTag string, err error)

+ func (c *Client) GetInstanceDimensionsBatchProcess(ctx context.Context, serviceAuthToken, instanceID string, ...) (eTag string, err error)

+ func (c *Client) GetInstanceDimensionsBytes(ctx context.Context, serviceAuthToken, instanceID string, q *QueryParams, ...) (b []byte, eTag string, err error)

+ func (c *Client) GetInstanceDimensionsInBatches(ctx context.Context, serviceAuthToken, instanceID string, ...) (dimensions Dimensions, eTag string, err error)

+ func (c *Client) GetInstances(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (m Instances, err error)

+ func (c *Client) GetInstancesBatchProcess(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) error

+ func (c *Client) GetInstancesInBatches(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string, ...) (instances Instances, err error)

+ func (c *Client) GetMetadataURL(id, edition, version string) string

+ func (c *Client) GetOptions(ctx context.Context, ...) (m Options, err error)

+ func (c *Client) GetOptionsBatchProcess(ctx context.Context, ...) error

+ func (c *Client) GetOptionsInBatches(ctx context.Context, ...) (opts Options, err error)

+ func (c *Client) GetVersion(ctx context.Context, ...) (m Version, err error)

+ func (c *Client) GetVersionDimensions(ctx context.Context, ...) (m VersionDimensions, err error)

+ func (c *Client) GetVersionMetadata(ctx context.Context, ...) (m Metadata, err error)

+ func (c *Client) GetVersions(ctx context.Context, ...) (m VersionsList, err error)

+ func (c *Client) GetVersionsBatchProcess(ctx context.Context, ...) error

+ func (c *Client) GetVersionsInBatches(ctx context.Context, ...) (versions VersionsList, err error)

+ func (c *Client) PatchInstanceDimensionOption(ctx context.Context, ...) (eTag string, err error)

+ func (c *Client) PostInstance(ctx context.Context, serviceAuthToken string, newInstance *NewInstance) (i *Instance, eTag string, err error)

+ func (c *Client) PostInstanceDimensions(ctx context.Context, serviceAuthToken, instanceID string, data OptionPost, ...) (eTag string, err error)

+ func (c *Client) PutDataset(ctx context.Context, ...) error

+ func (c *Client) PutInstance(ctx context.Context, ...) (eTag string, err error)

+ func (c *Client) PutInstanceData(ctx context.Context, serviceAuthToken, instanceID string, data JobInstance, ...) (eTag string, err error)

+ func (c *Client) PutInstanceImportTasks(ctx context.Context, serviceAuthToken, instanceID string, ...) (eTag string, err error)

+ func (c *Client) PutInstanceState(ctx context.Context, serviceAuthToken, instanceID string, state State, ...) (eTag string, err error)

+ func (c *Client) PutVersion(ctx context.Context, ...) error

+ func (c *Client) UpdateInstanceWithNewInserts(ctx context.Context, serviceAuthToken, instanceID string, ...) (eTag string, err error)

+ type CodeList struct

+ HRef string

+ ID string

+ IsHierarchy bool

+ Name string

+ type Contact struct

+ Email string

+ Name string

+ Telephone string

+ type Dataset struct

+ Current *DatasetDetails

+ ID string

+ Next *DatasetDetails

+ type DatasetDetails struct

+ CollectionID string

+ Contacts *[]Contact

+ Description string

+ ID string

+ Keywords *[]string

+ License string

+ Links Links

+ Methodologies *[]Methodology

+ NationalStatistic bool

+ NextRelease string

+ NomisReferenceURL string

+ Publications *[]Publication

+ Publisher *Publisher

+ QMI Publication

+ RelatedDatasets *[]RelatedDataset

+ ReleaseFrequency string

+ State string

+ Theme string

+ Title string

+ Type string

+ URI string

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

+ type DatasetsBatchProcessor func(List) (abort bool, err error)

+ type Dimension struct

+ DimensionID string

+ InstanceID string

+ Label string

+ Links Links

+ NodeID string

+ Option string

+ type Dimensions struct

+ Count int

+ Items []Dimension

+ Limit int

+ Offset int

+ TotalCount int

+ type Download struct

+ Private string

+ Public string

+ Size string

+ URL string

+ type DownloadList struct

+ CSV *Download

+ CSVW *Download

+ XLS *Download

+ type Edition struct

+ Edition string

+ ID string

+ Links Links

+ State string

+ type ErrInvalidDatasetAPIResponse struct

+ func NewDatasetAPIResponse(resp *http.Response, uri string) (e *ErrInvalidDatasetAPIResponse)

+ func (e ErrInvalidDatasetAPIResponse) Code() int

+ func (e ErrInvalidDatasetAPIResponse) Error() string

+ type Event struct

+ Message string

+ MessageOffset string

+ Time string

+ Type string

+ type ImportObservationsTask struct

+ InsertedObservations int64

+ State string

+ type Instance struct

+ type InstanceDimensionsBatchProcessor func(dimensions Dimensions, eTag string) (abort bool, err error)

+ type InstanceImportTasks struct

+ BuildHierarchyTasks []*BuildHierarchyTask

+ BuildSearchIndexTasks []*BuildSearchIndexTask

+ ImportObservations *ImportObservationsTask

+ type Instances struct

+ Count int

+ Items []Instance

+ Limit int

+ Offset int

+ TotalCount int

+ type InstancesBatchProcessor func(Instances) (abort bool, err error)

+ type IsBasedOn struct

+ ID string

+ Type string

+ type JobInstance struct

+ HeaderNames []string

+ NumberOfObservations int

+ type Link struct

+ ID string

+ URL string

+ type Links struct

+ AccessRights Link

+ Code Link

+ CodeList Link

+ Dataset Link

+ Dimensions Link

+ Edition Link

+ Editions Link

+ Job Link

+ LatestVersion Link

+ Options Link

+ Self Link

+ Taxonomy Link

+ Version Link

+ Versions Link

+ type List struct

+ Count int

+ Items []Dataset

+ Limit int

+ Offset int

+ TotalCount int

+ type Metadata struct

+ func (m Metadata) ToString() string

+ type Methodology struct

+ Description string

+ Title string

+ URL string

+ type NewInstance struct

+ Dimensions []CodeList

+ Events []Event

+ Headers []string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ LastUpdated string

+ Links *Links

+ State string

+ TotalObservations int

+ Type string

+ type Option struct

+ DimensionID string

+ Label string

+ Links Links

+ Option string

+ type OptionPost struct

+ Code string

+ CodeList string

+ Label string

+ Name string

+ Option string

+ Order *int

+ type Options struct

+ Count int

+ Items []Option

+ Limit int

+ Offset int

+ TotalCount int

+ func (m Options) String() string

+ type OptionsBatchProcessor func(Options) (abort bool, err error)

+ type Publication struct

+ Description string

+ Title string

+ URL string

+ type Publisher struct

+ Name string

+ Type string

+ URL string

+ type QueryParams struct

+ IDs []string

+ Limit int

+ Offset int

+ func (q *QueryParams) Validate() error

+ type RelatedDataset struct

+ Title string

+ URL string

+ type State int

+ const StateAssociated

+ const StateCompleted

+ const StateCreated

+ const StateDetached

+ const StateEditionConfirmed

+ const StateFailed

+ const StatePublished

+ const StateSubmitted

+ func (s State) String() string

+ type Temporal struct

+ EndDate string

+ Frequency string

+ StartDate string

+ type UpdateInstance struct

+ Alerts *[]Alert

+ CSVHeader []string

+ CollectionID string

+ Dimensions []VersionDimension

+ Downloads DownloadList

+ Edition string

+ ID string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ IsBasedOn *IsBasedOn

+ LatestChanges []Change

+ NumberOfObservations int64

+ ReleaseDate string

+ State string

+ Temporal []Temporal

+ Type string

+ Version int

+ type UsageNote struct

+ Note string

+ Title string

+ type Version struct

+ Alerts *[]Alert

+ CSVHeader []string

+ CollectionID string

+ Dimensions []VersionDimension

+ Downloads map[string]Download

+ Edition string

+ ID string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ LatestChanges []Change

+ Links Links

+ NumberOfObservations int64

+ ReleaseDate string

+ State string

+ Temporal []Temporal

+ UsageNotes *[]UsageNote

+ Version int

+ type VersionDimension struct

+ Description string

+ ID string

+ Label string

+ Links Links

+ Name string

+ NumberOfOptions int

+ URL string

+ Variable string

+ type VersionDimensionItems []VersionDimension

+ func (d VersionDimensionItems) Len() int

+ func (d VersionDimensionItems) Less(i, j int) bool

+ func (d VersionDimensionItems) Swap(i, j int)

+ type VersionDimensions struct

+ Items VersionDimensionItems

+ type VersionsBatchProcessor func(VersionsList) (abort bool, err error)

+ type VersionsList struct

+ Count int

+ Items []Version

+ Limit int

+ Offset int

+ TotalCount int