dataset

package

Go to main page

Versions in this module

v1

v1.43.0

Aug 27, 2021

v1.42.0

Aug 11, 2021

v1.41.1

Jul 2, 2021

v1.41.0

Jul 2, 2021

v1.40.0

Jun 25, 2021

Changes in this version

type State

+ const StateDetached

v1.39.0

Jun 16, 2021

v1.38.0

Jun 15, 2021

Changes in this version

type Client

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

+ type CodeList struct

+ HRef string

+ ID string

+ IsHierarchy bool

+ Name string

+ type Event struct

+ Message string

+ MessageOffset string

+ Time string

+ Type string

+ type NewInstance struct

+ Dimensions []CodeList

+ Events []Event

+ Headers []string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ LastUpdated string

+ Links *Links

+ State string

+ TotalObservations int

v1.37.1

Jun 14, 2021

v1.37.0

Jun 11, 2021

v1.36.1

Jun 10, 2021

v1.36.0

May 24, 2021

Changes in this version

type Client

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

+ func (c *Client) GetInstanceDimensionsInBatches(ctx context.Context, userAuthToken, serviceAuthToken, instanceID string, ...) (dimensions Dimensions, 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)

type Dimensions

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

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

type Instances

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

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

v1.35.0

May 20, 2021

v1.34.4

Apr 28, 2021

v1.34.3

Apr 14, 2021

Changes in this version

type Client

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

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

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

+ type VersionsList struct

+ Count int

+ Items []Version

+ Limit int

+ Offset int

+ TotalCount int

v1.34.2

Mar 9, 2021

Changes in this version

type Client

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

type OptionPost

+ Order *int

v1.34.1

Mar 8, 2021

v1.34.0

Feb 23, 2021

Changes in this version

type Client

+ 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)

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

type List

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

v1.33.6

Feb 18, 2021

Changes in this version

type DatasetDetails

+ NomisReferenceURL string

+ Type string

type Version

+ UsageNotes *[]UsageNote

v1.33.5

Feb 17, 2021

v1.33.4

Feb 12, 2021

v1.33.3

Feb 9, 2021

v1.33.2

Feb 5, 2021

Changes in this version

+ type UpdateInstance struct

+ Alerts *[]Alert

+ CSVHeader []string

+ CollectionID string

+ Dimensions []VersionDimension

+ Downloads map[string]Download

+ Edition string

+ ID string

+ ImportTasks *InstanceImportTasks

+ InstanceID string

+ LatestChanges []Change

+ NumberOfObservations int64

+ ReleaseDate string

+ State string

+ Temporal []Temporal

+ Version int

v1.33.1

Feb 3, 2021

v1.33.0

Jan 27, 2021

v1.32.10

Jan 26, 2021

v1.32.9

Jan 26, 2021

v1.32.8

Jan 26, 2021

v1.32.7

Jan 25, 2021

Changes in this version

type Client

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

v1.32.6

Jan 22, 2021

v1.32.5

Jan 21, 2021

v1.32.4

Jan 18, 2021

v1.32.3

Jan 12, 2021

Changes in this version

type Client

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

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

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

v1.32.2

Jan 11, 2021

v1.32.1

Dec 30, 2020

v1.32.0

Dec 24, 2020

v1.31.2

Dec 23, 2020

Changes in this version

+ var MaxIDs = func() int

+ type QueryParams struct

+ IDs []string

+ Limit int

+ Offset int

+ func (q QueryParams) Validate() error

v1.31.1

Dec 17, 2020

Changes in this version

type Client

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

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

v1.31.0

Dec 9, 2020

Changes in this version

type Options

+ Count int

+ Limit int

+ Offset int

+ TotalCount int

v1.30.4

Dec 2, 2020

v1.30.3

Nov 30, 2020

v1.30.2

Oct 26, 2020

v1.30.1

Oct 23, 2020

v1.30.0

Sep 24, 2020

v1.29.0

Sep 9, 2020

v1.28.0

Aug 28, 2020

v1.27.0

Aug 26, 2020

v1.26.0

Aug 18, 2020

v1.25.0

Aug 17, 2020

v1.24.0

Aug 12, 2020

Changes in this version

type Client

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

v1.23.0

Aug 11, 2020

v1.22.0

Aug 11, 2020

v1.21.0

Aug 3, 2020

v1.20.1

Jul 28, 2020

v1.20.0

Jul 14, 2020

v1.19.0

Jul 10, 2020

v1.18.0

Jul 7, 2020

v1.17.0

Jul 6, 2020

v1.16.0

Jun 30, 2020

v1.15.0

Jun 29, 2020

v1.14.0

Jun 23, 2020

v1.13.1

Jun 17, 2020

v1.13.0

Jun 15, 2020

v1.12.0

Jun 11, 2020

v1.11.0

May 26, 2020

v1.10.1

May 11, 2020

v1.10.0

May 7, 2020

v1.9.0

Mar 18, 2020

Changes in this version

type Client

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

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

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

type Dimension

+ DimensionID string

+ InstanceID string

+ NodeID string

+ Option string

type Version

+ CSVHeader []string

+ type VersionDimension struct

+ Description string

+ ID string

+ Label string

+ Links Links

+ Name string

+ URL 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

v1.8.0

Mar 12, 2020

Changes in this version

type State

+ const StateAssociated

+ const StateEditionConfirmed

+ const StateFailed

+ const StatePublished

v1.7.0

Mar 6, 2020

Changes in this version

+ type BuildHierarchyTask struct

+ CodeListID string

+ DimensionName string

+ State string

+ type BuildSearchIndexTask struct

+ DimensionName string

+ State string

type Client

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

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

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

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

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

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

+ type ImportObservationsTask struct

+ InsertedObservations int64

+ State string

+ type InstanceImportTasks struct

+ BuildHierarchyTasks []*BuildHierarchyTask

+ BuildSearchIndexTasks []*BuildSearchIndexTask

+ ImportObservations *ImportObservationsTask

+ type Instances struct

+ Items []Instance

type Links

+ Job Link

+ type State int

+ const StateCompleted

+ const StateCreated

+ const StateSubmitted

+ func (s State) String() string

type Version

+ ImportTasks *InstanceImportTasks

+ NumberOfObservations int64

v1.6.0

Mar 2, 2020

Changes in this version

type Client

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

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

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

type Dimension

+ ID string

+ type JobInstance struct

+ HeaderNames []string

+ NumberOfObservations int

+ type OptionPost struct

+ Code string

+ CodeList string

+ Label string

+ Name string

+ Option string

v1.5.0

Feb 26, 2020

v1.4.0

Feb 24, 2020

v1.3.0

Feb 21, 2020

v1.2.0

Feb 5, 2020

v1.1.0

Feb 3, 2020

v1.0.0

Jan 31, 2020

Changes in this version

+ type Alert struct

+ Date string

+ Description string

+ Type string

+ type Change struct

+ Description string

+ Name string

+ Type string

+ type Client struct

+ func NewAPIClient(datasetAPIURL string) *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) GetDatasets(ctx context.Context, userAuthToken, serviceAuthToken, collectionID string) (m List, err error)

+ func (c *Client) GetDimensions(ctx context.Context, ...) (m Dimensions, 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, 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) GetVersion(ctx context.Context, ...) (m Version, err error)

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

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

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

+ 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

+ Publications *[]Publication

+ Publisher *Publisher

+ QMI Publication

+ RelatedDatasets *[]RelatedDataset

+ ReleaseFrequency string

+ State string

+ Theme string

+ Title string

+ URI string

+ UnitOfMeasure string

+ UsageNotes *[]UsageNote

+ type Dimension struct

+ Description string

+ Label string

+ Links Links

+ Name string

+ URL string

+ type Dimensions struct

+ Items Items

+ 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 Instance struct

+ type Items []Dimension

+ func (d Items) Len() int

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

+ func (d Items) Swap(i, j 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

+ LatestVersion Link

+ Options Link

+ Self Link

+ Taxonomy Link

+ Version Link

+ Versions Link

+ type List struct

+ Items []Dataset

+ type Metadata struct

+ func (m Metadata) ToString() string

+ type Methodology struct

+ Description string

+ Title string

+ URL string

+ type Option struct

+ DimensionID string

+ Label string

+ Links Links

+ Option string

+ type Options struct

+ Items []Option

+ func (m Options) String() string

+ type Publication struct

+ Description string

+ Title string

+ URL string

+ type Publisher struct

+ Name string

+ Type string

+ URL string

+ type RelatedDataset struct

+ Title string

+ URL string

+ type Temporal struct

+ EndDate string

+ Frequency string

+ StartDate string

+ type UsageNote struct

+ Note string

+ Title string

+ type Version struct

+ Alerts *[]Alert

+ CollectionID string

+ Dimensions []Dimension

+ Downloads map[string]Download

+ Edition string

+ ID string

+ InstanceID string

+ LatestChanges []Change

+ Links Links

+ ReleaseDate string

+ State string

+ Temporal []Temporal

+ Version int

Other modules containing this package

github.com/ONSdigital/dp-api-clients-go/v2

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