ske

Documentation

Overview

Package ske provides primitives to interact with the openapi HTTP API.

Code generated by github.com/do87/stackit-client-generator version (devel) DO NOT EDIT.

Index

• type Client
  • func NewRawClient(server string, opts ...ClientOption) (*Client, error)
• type ClientOption
  • func WithBaseURL(baseURL string) ClientOption
  • func WithHTTPClient(doer skeclient.HttpRequestDoer) ClientOption
• type ClientWithResponses
  • func NewClient(server string, opts ...ClientOption) (*ClientWithResponses, error)

Types

type Client

type Client struct {
	// list of connected client services
	Cluster         *cluster.Client
	Credentials     *credentials.Client
	Operation       *operation.Client
	ProviderOptions *provideroptions.Client
	Project         *project.Client

	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client skeclient.HttpRequestDoer
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient(server string, opts ...ClientOption) (*Client, error)

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer skeclient.HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

type ClientWithResponses

type ClientWithResponses struct {
	Client *Client

	// list of connected client services
	Cluster         *cluster.ClientWithResponses
	Credentials     *credentials.ClientWithResponses
	Operation       *operation.ClientWithResponses
	ProviderOptions *provideroptions.ClientWithResponses
	Project         *project.ClientWithResponses
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

func NewClient(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClient creates a new ClientWithResponses, which wraps Client with return type handling