client

Documentation

Index

• Variables
• func DefaultTransport() http.RoundTripper
• func NewTransport(next http.RoundTripper) http.RoundTripper
• type ApiError
  • func (e *ApiError) Error() string
• type ErrorResponse
• type GitlabNetClient
  • func NewGitlabNetClient(user, password, secret string, httpClient *HttpClient) (*GitlabNetClient, error)
  • func (c *GitlabNetClient) Do(request *http.Request) (*http.Response, error)
  • func (c *GitlabNetClient) DoRequest(ctx context.Context, method, path string, data interface{}) (*http.Response, error)
  • func (c *GitlabNetClient) Get(ctx context.Context, path string) (*http.Response, error)
  • func (c *GitlabNetClient) Post(ctx context.Context, path string, data interface{}) (*http.Response, error)
  • func (c *GitlabNetClient) SetUserAgent(ua string)
• type HTTPClientOpt
  • func WithClientCert(certPath, keyPath string) HTTPClientOpt
  • func WithHTTPRetryOpts(waitMin, waitMax time.Duration, maxAttempts int) HTTPClientOpt
• type HttpClient
  • func NewHTTPClientWithOpts(gitlabURL, gitlabRelativeURLRoot, caFile, caPath string, ...) (*HttpClient, error)
• type OriginalRemoteIPContextKey

Variables

var ErrCafileNotFound = errors.New("cafile not found")

Functions

func DefaultTransport

func DefaultTransport() http.RoundTripper

func NewTransport

func NewTransport(next http.RoundTripper) http.RoundTripper

Types

type ApiError

type ApiError struct {
	Msg string
}

func (*ApiError) Error

func (e *ApiError) Error() string

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
}

type GitlabNetClient

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

func NewGitlabNetClient

func NewGitlabNetClient(
	user,
	password,
	secret string,
	httpClient *HttpClient,
) (*GitlabNetClient, error)

func (*GitlabNetClient) Do

func (c *GitlabNetClient) Do(request *http.Request) (*http.Response, error)

func (*GitlabNetClient) DoRequest

func (c *GitlabNetClient) DoRequest(ctx context.Context, method, path string, data interface{}) (*http.Response, error)

func (*GitlabNetClient) Get

func (c *GitlabNetClient) Get(ctx context.Context, path string) (*http.Response, error)

func (*GitlabNetClient) Post

func (c *GitlabNetClient) Post(ctx context.Context, path string, data interface{}) (*http.Response, error)

func (*GitlabNetClient) SetUserAgent

func (c *GitlabNetClient) SetUserAgent(ua string)

SetUserAgent overrides the default user agent for the User-Agent header field for subsequent requests for the GitlabNetClient

type HTTPClientOpt

type HTTPClientOpt func(*httpClientCfg)

HTTPClientOpt provides options for configuring an HttpClient

func WithClientCert

func WithClientCert(certPath, keyPath string) HTTPClientOpt

WithClientCert will configure the HttpClient to provide client certificates when connecting to a server.

func WithHTTPRetryOpts

func WithHTTPRetryOpts(waitMin, waitMax time.Duration, maxAttempts int) HTTPClientOpt

type HttpClient

type HttpClient struct {
	RetryableHTTP *retryablehttp.Client
	Host          string
}

func NewHTTPClientWithOpts

func NewHTTPClientWithOpts(gitlabURL, gitlabRelativeURLRoot, caFile, caPath string, readTimeoutSeconds uint64, opts []HTTPClientOpt) (*HttpClient, error)

NewHTTPClientWithOpts builds an HTTP client using the provided options

type OriginalRemoteIPContextKey

type OriginalRemoteIPContextKey struct{}

To use as the key in a Context to set an X-Forwarded-For header in a request