client

README

Community Go Client for STACKIT

The client is community-supported and not an official STACKIT release, it is maintained by internal Schwarz IT teams integrating with STACKIT

Install

To install the latest stable release, run:

go get github.com/SchwarzIT/community-stackit-go-client@latest

Usage Example

In order to use the client, a STACKIT Service Account must be created and have relevant roles assigned to it.
For further assistance, please contact STACKIT support

package main

import (
	"context"
	"fmt"
	"os"

	client "github.com/SchwarzIT/community-stackit-go-client"
	"github.com/SchwarzIT/community-stackit-go-client/pkg/validate"
)

func main() {
	ctx := context.Background()
	c, err := client.New(ctx, client.Config{
		ServiceAccountEmail: os.Getenv("STACKIT_SERVICE_ACCOUNT_EMAIL"),
		ServiceAccountToken: os.Getenv("STACKIT_SERVICE_ACCOUNT_TOKEN"),
	})
	if err != nil {
		panic(err)
	}

	projectID := "123-456-789"
	res, err := c.ElasticSearch.Offerings.GetWithResponse(ctx, projectID)
	if aggregatedError := validate.Response(res, err, "JSON200"); aggregatedError != nil {
		panic(aggregatedError)
	}

	fmt.Println("Received the following offerings:")
	for _, o := range res.JSON200.Offerings {
		fmt.Printf("- %s\n", o.Name)
	}
}

Further usage examples can be found in terraform-provider-stackit

Documentation

Index

• Constants
• type Client
  • func MockServer() (c *Client, mux *http.ServeMux, teardown func(), err error)
  • func New(ctx context.Context, cfg Config) (*Client, error)
  • func (c *Client) Do(req *http.Request) (*http.Response, error)
  • func (c *Client) GetBaseURL() string
  • func (c *Client) GetConfig() Config
  • func (c *Client) GetHTTPClient() *http.Client
  • func (c *Client) LegacyDo(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)
  • func (c *Client) Request(ctx context.Context, method, path string, body []byte) (*http.Request, error)
  • func (c *Client) SetBaseURL(url string) error
  • func (c *Client) SetToken(token string)
• type Config
  • func (c *Config) SetURL(value string) error
  • func (c *Config) Validate() error

Constants

const (
	ClientTimeoutErr         = "Client.Timeout exceeded while awaiting headers"
	ClientContextDeadlineErr = "context deadline exceeded"
	ClientEOFError           = "unexpected EOF"
)

Types

type Client

type Client struct {

	// when an internal server error is encountered
	// the call will be retried
	RetryTimout time.Duration // timeout for retrying a call
	RetryWait   time.Duration // how long to wait before trying again
	// contains filtered or unexported fields
}

Client service for managing interactions with STACKIT API

func MockServer

func MockServer() (c *Client, mux *http.ServeMux, teardown func(), err error)

MockServer mocks STACKIT api server and returns a client pointing to it, mux, teardown function and an error indicator

func New

func New(ctx context.Context, cfg Config) (*Client, error)

New returns a new client

func (*Client) Do

func (c *Client) Do(req *http.Request) (*http.Response, error)

func (*Client) GetBaseURL

func (c *Client) GetBaseURL() string

GetBaseURL returns the base url string

func (*Client) GetConfig

func (c *Client) GetConfig() Config

GetConfig returns the client config

func (*Client) GetHTTPClient

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

GetHTTPClient returns the HTTP client

func (*Client) LegacyDo

func (c *Client) LegacyDo(req *http.Request, v interface{}, errorHandlers ...func(*http.Response) error) (*http.Response, error)

LegacyDo performs the request, including retry if set To set retry, use WithRetry() which returns a shalow copy of the client

func (*Client) Request

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

Request creates a new API request

func (*Client) SetBaseURL

func (c *Client) SetBaseURL(url string) error

SetBaseURL sets the base url

func (*Client) SetToken

func (c *Client) SetToken(token string)

type Config

type Config struct {
	BaseUrl             *url.URL
	ServiceAccountToken string
	ServiceAccountEmail string
}

Config is the STACKIT client configuration

func (*Config) SetURL

func (c *Config) SetURL(value string) error

SetURL sets a given url string as the base url in the config if the given value is empty, the default base URL will be used

func (*Config) Validate

func (c *Config) Validate() error

Validate verifies that the given config is valid