rest

type AddEntriesToResult ¶

type AddEntriesToResult func(body []byte) (receivedEntries int, err error)

AddEntriesToResult is a function which should parse an API response body and append the returned entries to a result slice. Handling the parsing, any possible filtering and owning and filling the result list is left to the caller of ListPaginated, as it might differ notably between client implementations. The function MUST return the number of entries it has parsed from the received API payload body. This is used to validate that the final parsed number matches the reported total count of the API. This receivedEntries count is not necessarily equal to the number of entries added to the result slice, as filtering might exclude some entries that where received from the API.

type Client ¶ added in v2.6.0

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

func NewRestClient(client *http.Client, trafficLogger *trafficlogs.FileBasedLogger, strategy RateLimitStrategy) *Client

func (c Client) Client() *http.Client

func (c Client) Delete(ctx context.Context, url string) (Response, error)

func (c Client) Get(ctx context.Context, url string) (Response, error)

func (c Client) GetWithRetry(ctx context.Context, url string, settings RetrySetting) (resp Response, err error)

func (c Client) Post(ctx context.Context, url string, data []byte) (Response, error)

func (c Client) PostMultiPartFile(ctx context.Context, url string, data *bytes.Buffer, contentType string) (Response, error)

func (c Client) Put(ctx context.Context, url string, data []byte) (Response, error)

type RateLimitStrategy ¶ added in v2.6.0

type RateLimitStrategy interface {
	ExecuteRequest(timelineProvider timeutils.TimelineProvider, callback func() (Response, error)) (Response, error)
}

RateLimitStrategy ensures that the concrete implementation of the rate limiting strategy can be hidden behind this interface

func CreateRateLimitStrategy() RateLimitStrategy

type RequestInfo ¶

type RequestInfo struct {
	// HTTP Method of the request
	Method string `json:"method"`
	// URL that was called
	URL string `json:"url"`
}

type RespError ¶

type RespError struct {
	// Reason describing what went wrong
	Reason string `json:"reason"`
	// StatusCode is the HTTP status code
	StatusCode int `json:"statusCode"`
	// Body of the HTTP response
	Body string `json:"body"`
	// Err is the underlying error that occurred - maybe be empty
	Err error `json:"error"`
	// Request contains information about the HTTP request that caused the RespError
	Request *RequestInfo `json:"request"`
}

RespError represents a HTTP response error

func NewRespErr(reason string, resp Response) RespError

func (e RespError) ConcurrentError() string

func (e RespError) Error() string

func (e RespError) Unwrap() error

func (e RespError) WithErr(err error) RespError

func (e RespError) WithRequestInfo(reqMethod, reqURL string) RespError

type Response ¶

type Response struct {
	StatusCode  int
	Body        []byte
	Headers     map[string][]string
	NextPageKey string
	TotalCount  int
	PageSize    int
}

func ListPaginated(ctx context.Context, client *Client, retrySettings RetrySettings, url *url.URL, logLabel string,
	addToResult AddEntriesToResult) (Response, error)

func SendWithRetry(ctx context.Context, sendWithBody SendRequestWithBody, path string, body []byte, setting RetrySetting) (resp Response, err error)

func SendWithRetryWithInitialTry(ctx context.Context, sendWithBody SendRequestWithBody, path string, body []byte, setting RetrySetting) (resp Response, err error)

func (resp Response) Is4xxError() bool

func (resp Response) Is5xxError() bool

func (resp Response) IsSuccess() bool

type RetrySetting ¶

type RetrySetting struct {
	WaitTime   time.Duration
	MaxRetries int
}

type RetrySettings ¶

type RetrySettings struct {
	Normal   RetrySetting
	Long     RetrySetting
	VeryLong RetrySetting
}

type SendRequestWithBody ¶

type SendRequestWithBody func(ctx context.Context, url string, data []byte) (Response, error)

SendRequestWithBody is a function doing a PUT or POST HTTP request