client

Documentation

Index

• Constants
• func NewDefaultHTTPClient() *http.Client
• func NewDefaultHTTPTransport() http.RoundTripper
• type Client
  • func New(username, password string, c ...ConfigFn) *Client
  • func (c *Client) Delete(ctx context.Context, path string) ([]byte, error)
  • func (c *Client) Do(r *http.Request) ([]byte, error)
  • func (c *Client) Get(ctx context.Context, path string) ([]byte, error)
  • func (c *Client) Patch(ctx context.Context, path string, body []byte) ([]byte, error)
  • func (c *Client) Post(ctx context.Context, path string, body []byte) ([]byte, error)
  • func (c *Client) Put(ctx context.Context, path string, body []byte) ([]byte, error)
• type ConfigFn
  • func WithBaseURL(baseURL string) ConfigFn
  • func WithHTTPClient(httpClient *http.Client) ConfigFn
  • func WithInsecureSkipVerify() ConfigFn
  • func WithLogger(logger LogFn) ConfigFn
  • func WithTimeout(timeout time.Duration) ConfigFn
• type Error
  • func (e *Error) Error() string
• type ErrorType
• type LogFn

Examples

• WithHTTPClient
• WithTimeout

Constants

const (
	Version    string = "8.14.0"
	APIVersion string = "1.3"
	APIBaseURL string = "https://api.upcloud.com"

	EnvDebugAPIBaseURL            string = "UPCLOUD_DEBUG_API_BASE_URL"
	EnvDebugSkipCertificateVerify string = "UPCLOUD_DEBUG_SKIP_CERTIFICATE_VERIFY"
)

const (
	ErrorTypeError = iota
	ErrorTypeProblem
)

Functions

func NewDefaultHTTPClient

func NewDefaultHTTPClient() *http.Client

NewDefaultHTTPClient returns new default http.Client.

func NewDefaultHTTPTransport

func NewDefaultHTTPTransport() http.RoundTripper

NewDefaultHTTPTransport return new HTTP client transport round tripper.

Types

type Client

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

Client represents an API client

func New

func New(username, password string, c ...ConfigFn) *Client

New creates and returns a new client configured with the specified user and password and optional config functions.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, path string) ([]byte, error)

Delete performs a DELETE request to the specified path and returns the response body.

func (*Client) Do

func (c *Client) Do(r *http.Request) ([]byte, error)

Do performs HTTP request and returns the response body.

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string) ([]byte, error)

Get performs a GET request to the specified path and returns the response body.

func (*Client) Patch

func (c *Client) Patch(ctx context.Context, path string, body []byte) ([]byte, error)

Patch performs a PATCH request to the specified path and returns the response body.

func (*Client) Post

func (c *Client) Post(ctx context.Context, path string, body []byte) ([]byte, error)

Post performs a POST request to the specified path and returns the response body.

func (*Client) Put

func (c *Client) Put(ctx context.Context, path string, body []byte) ([]byte, error)

Put performs a PUT request to the specified path and returns the response body.

type ConfigFn

type ConfigFn func(o *config)

func WithBaseURL

func WithBaseURL(baseURL string) ConfigFn

WithBaseURL modifies the client baseURL

func WithHTTPClient

func WithHTTPClient(httpClient *http.Client) ConfigFn

WithHTTPClient replaces the client's default httpClient with the specified one

Example

httpClient := &http.Client{
	// setup custom HTTP client
}
New(os.Getenv("UPCLOUD_USERNAME"), os.Getenv("UPCLOUD_PASSWORD"), WithHTTPClient(httpClient))

func WithInsecureSkipVerify

func WithInsecureSkipVerify() ConfigFn

WithInsecureSkipVerify modifies the client's httpClient to skip verifying the server's certificate chain and host name. This should be used only for testing.

func WithLogger

func WithLogger(logger LogFn) ConfigFn

WithLogger configures logging function that logs requests and responses

func WithTimeout

func WithTimeout(timeout time.Duration) ConfigFn

WithTimeout modifies the client's httpClient timeout

Example

New(os.Getenv("UPCLOUD_USERNAME"), os.Getenv("UPCLOUD_PASSWORD"), WithTimeout(10*time.Second))

type Error

type Error struct {
	ErrorCode    int
	ErrorMessage string
	ResponseBody []byte
	Type         ErrorType
}

Error represents an error returned from the client. Errors are thrown when requests don't have a successful status code

func (*Error) Error

func (e *Error) Error() string

Error implements the Error interface

type ErrorType

type ErrorType int

type LogFn

type LogFn func(context.Context, string, ...any)

LogFn is a function that logs a message with context and optional key-value pairs, e.g., slog.DebugContext