Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	BaseURL *url.URL
	// contains filtered or unexported fields
}

    Client is a simple HTTP client for the REST API.

    func New

    func New(base string, options ...Option) (*Client, error)

      New returns a newly configured REST API Client.

      func (*Client) Call

      func (c *Client) Call(ctx context.Context, method string, rel *url.URL, body, out interface{}) (err error)

        Call executes the desired REST API request.

        func (*Client) Metrics

        func (c *Client) Metrics(ctx context.Context) (ret []v1.Metric, err error)

          Metrics returns the current metrics summary.

          func (*Client) SetStatus

          func (c *Client) SetStatus(ctx context.Context, patch v1.Status) (ret v1.Status, err error)

            SetStatus tries to change the current status and returns the new one if it was successful.

            func (*Client) Status

            func (c *Client) Status(ctx context.Context) (ret v1.Status, err error)

              Status returns the current k6 status.

              type Option

              type Option func(*Client)

                Option function are helpers that enable the flexible configuration of the REST API client.

                func WithHTTPClient

                func WithHTTPClient(httpClient *http.Client) Option

                  WithHTTPClient configures the supplied HTTP client to be used when making REST API requests.

                  func WithLogger

                  func WithLogger(logger *logrus.Entry) Option

                    WithLogger sets the specifield logger to the client.