sdk

package

v1.74.0 Latest Latest Go to latest Published: Apr 8, 2025 License: MIT Imports: 11 Imported by: 9

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ONSdigital/dp-dataset-api

Links

Open Source Insights

Documentation ¶

Index ¶

type Client
- func New(datasetAPIUrl string) *Client
- func NewWithHealthClient(hcCli *health.Client) *Client

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

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

func New ¶

func New(datasetAPIUrl string) *Client

New creates a new instance of Client for the service

func NewWithHealthClient ¶

func NewWithHealthClient(hcCli *health.Client) *Client

NewWithHealthClient creates a new instance of service API Client, reusing the URL and Clienter from the provided healthcheck client

func (*Client) Checker ¶

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

Checker calls topic api health endpoint and returns a check object to the caller

func (*Client) GetVersion ¶

func (c *Client) GetVersion(ctx context.Context, userAccessToken, serviceToken,
	downloadServiceToken, collectionID, datasetID, editionID, versionID string) (v models.Version, err error)

GetVersion gets a specific version for an edition from the dataset api

func (*Client) Health ¶

func (c *Client) Health() *health.Client

Health returns the underlying Healthcheck Client for this API client

func (*Client) URL ¶

func (c *Client) URL() string

URL returns the URL used by this client

Source Files ¶

View all Source files

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