# Functions
NewAPIClient creates a new instance of Client with a given dataset api url and the relevant tokens.
NewAPIClientWithMaxRetries creates a new instance of Client with a given dataset api url and the relevant tokens, setting a number of max retires for the HTTP client.
NewDatasetAPIResponse creates an error response, optionally adding body to e when status is 404.
NewWithHealthClient creates a new instance of Client, reusing the URL and Clienter from the provided health check client.
# Constants
not editions.
Instances only.
Possible values for a State of the resource.
Possible values for a State of the resource.
instances and versions only.
Instances only.
Possible values for a State of the resource.
Possible values for a State of the resource.
# Variables
No description provided by the author
MaxIDs returns the maximum number of IDs acceptable in a list.
# Structs
Alert represents an alert returned by the dataset api.
BuildHierarchyTask represents a task of importing a single hierarchy.
BuildSearchIndexTask represents a task of importing a single search index into search.
Change represents a change returned for a version by the dataset api.
Client is a dataset api client which can be used to make requests to the server.
CodeList holds one of the codelists corresponding to a new Instance.
Contact represents a response model within a dataset.
Dataset represents a dataset resource.
DatasetDetails represents a response dataset model from the dataset api.
Dimension represents a response model for a dimension endpoint.
Dimensions represents a list of dimensions.
Download represents a version download from the dataset api.
DownloadList represents a list of objects of containing information on the downloadable files.
EditableMetadata represents the metadata fields that can be edited.
Edition represents an edition within a dataset.
No description provided by the author
No description provided by the author
ErrInvalidDatasetAPIResponse is returned when the dataset api does not respond with a valid status.
Event holds one of the event which has happened to a new Instance.
No description provided by the author
No description provided by the author
ImportObservationsTask represents the task of importing instance observation data into the database.
Instance represents an instance within a dataset.
InstanceImportTasks represents all of the tasks required to complete an import job.
Instances represent a list of Instance objects.
IsBasedOn is a special set of json-ld metadata for Cantabular datasets For more information on json-ld markup see: https://moz.com/blog/json-ld-for-beginners.
JobInstance represents the details necessary to update (PUT) a job instance.
Link represents a single link within a dataset model.
Links represent the Links within a dataset model.
List represents an object containing a list of datasets.
Metadata is a combination of version and dataset model fields.
Methodology represents a methodology document returned by the dataset api.
NewInstance which presents a single dataset being imported.
Option represents a response model for an option.
OptionPost represents an option model to store in the dataset api.
Options represents a list of options from the dataset api.
OptionUpdate represents an update for an existing option.
Publication represents a publication document returned by the dataset api.
Publisher represents the publisher within the dataset.
QueryParams represents the possible query parameters that a caller can provide.
RelatedDataset represents a related dataset document returned by the dataset api.
ResponseHedaers represents headers that are available in the HTTP response.
Temporal represents a temporal returned by the dataset api.
No description provided by the author
UsageNote represents a note containing extra information associated to the resource.
Version represents a version within a dataset.
VersionDimension represents a dimension model nested in the Version model.
VersionDimensions represent a list of versionDimension.
VersionsList represents an object containing a list of datasets.
# Type aliases
DatasetsBatchProcessor is the type corresponding to a batch processing function for a dataset List.
InstanceDimensionsBatchProcessor is the type corresponding to a batch processing function for Instance dimensions.
InstancesBatchProcessor is the type corresponding to a batch processing function for Instances.
OptionsBatchProcessor is the type corresponding to a batch processing function for dataset Options.
State - iota enum of possible states.
VersionDimensionItems represents a list of Version Dimensions.
VersionsBatchProcessor is the type corresponding to a batch processing function for a dataset List.