Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuthHeaders ¶ added in v2.153.0
AuthHeaders represents the common set of headers required for making authorized requests
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a filter api client which can be used to make requests to the server
func NewWithHealthClient ¶
NewWithHealthClient creates a new instance of Client, reusing the URL and Clienter from the provided health check client.
func (*Client) Checker ¶
func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error
Checker calls filter api health endpoint and returns a check object to the caller.
func (*Client) DeleteOption ¶ added in v2.153.0
func (*Client) ForwardRequest ¶
ForwardRequest is used for forwarding a request from another service. Initially implemented for fowarding requests for Cantabular based datasets from dp-filter-api. The provided request is expected have any required headers as the original request will have been made using the relevant api-client. Note that the caller is responsible for closing the response body as with making a regular http request.
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is the package's error type
type GetDeleteOptionInput ¶ added in v2.153.0
type GetDeleteOptionInput struct { FilterID string Dimension string Option string IfMatch string AuthHeaders }
getFilterInput holds the required fields for making the GET /filters API call