sdk

package

v1.11.0 Latest Latest Go to latest Published: Sep 16, 2026 License: MIT Imports: 15 Imported by: 0

Details

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

Repository

github.com/ONSdigital/dp-legacy-cache-api

Links

Open Source Insights

Documentation ¶

Index ¶

type Auth
- func (a *Auth) Add(req *http.Request)
type Client
- func New(legacyCacheAPI string) *Client
- func NewWithHealthClient(hcCli *healthcheck.Client) *Client
type Clienter
type Options
type ResponseInfo

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Auth ¶

type Auth struct {
	ServiceAuthToken string `json:"-"`
	UserAccessToken  string `json:"-"`
}

func (*Auth) Add ¶

func (a *Auth) Add(req *http.Request)

type Client ¶

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

func New ¶

func New(legacyCacheAPI string) *Client

New creates a new instance of Client with a given legacy cache API URL

func NewWithHealthClient ¶

func NewWithHealthClient(hcCli *healthcheck.Client) *Client

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

func (*Client) Checker ¶

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

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

func (*Client) GetCacheTimes ¶

func (cli *Client) GetCacheTimes(ctx context.Context, auth Auth, opts Options) (*models.CacheTimesList, apiError.Error)

GetCacheTimes gets a list of cache times

func (*Client) Health ¶

func (cli *Client) Health() *healthcheck.Client

Health returns the underlying Healthcheck Client for this legacy cache API client

func (*Client) URL ¶

func (cli *Client) URL() string

URL returns the URL used by this client

type Clienter ¶

type Clienter interface {
	Checker(ctx context.Context, check *healthcheck.CheckState) error
	Health() *health.Client
	URL() string
	GetCacheTimes(ctx context.Context, auth Auth, options Options) (*models.CacheTimesList, apiError.Error)
}

type Options ¶

type Options struct {
	Limit       int
	Offset      int
	ReleaseTime time.Time
}

type ResponseInfo ¶

type ResponseInfo struct {
	Body    []byte
	Headers http.Header
	Status  int
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
errors
mocks

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