client

Documentation

Index

• Variables
• type APIError
  • func (e *APIError) Error() string
• type ErrorResponse
• type GitlabNetClient
  • func NewGitlabNetClient(user, password, secret string, httpClient *HTTPClient) (*GitlabNetClient, 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 HTTPClient
  • func NewHTTPClientWithOpts(gitlabURL, gitlabRelativeURLRoot, caFile, caPath string, ...) (*HTTPClient, error)
• type HTTPClientOpt
  • func WithClientCert(certPath, keyPath string) HTTPClientOpt
• type OriginalRemoteIPContextKey

Variables

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

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) 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 HTTPClient

type HTTPClient struct {
	*http.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 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.

type OriginalRemoteIPContextKey

type OriginalRemoteIPContextKey struct{}

OriginalRemoteIPContextKey is to be used as the key in a Context to set an X-Forwarded-For header in a request