Documentation ¶
Index ¶
- Variables
- func Bool(b bool) *bool
- func Float32(f float32) *float32
- func Float64(f float64) *float64
- func Int(i int) *int
- func Int64(i int64) *int64
- func String(s string) *string
- type HTTPClient
- type Northflank
- type SDKOption
- func WithClient(client HTTPClient) SDKOption
- func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
- func WithSecurity(security shared.Security) SDKOption
- func WithSecuritySource(security func(context.Context) (shared.Security, error)) SDKOption
- func WithServerIndex(serverIndex int) SDKOption
- func WithServerURL(serverURL string) SDKOption
- func WithTemplatedServerURL(serverURL string, params map[string]string) SDKOption
Constants ¶
This section is empty.
Variables ¶
View Source
var ServerList = []string{
"https://api.northflank.com",
}
ServerList contains the list of servers available to the SDK
Functions ¶
Types ¶
type HTTPClient ¶
HTTPClient provides an interface for suplying the SDK with a custom HTTP client
type Northflank ¶
type Northflank struct { Addons *addons Billing *billing CloudProviders *cloudProviders Domains *domains Integrations *integrations Miscellaneous *miscellaneous // contains filtered or unexported fields }
Northflank API: This is the API for northflank.com
func New ¶
func New(opts ...SDKOption) *Northflank
New creates a new instance of the SDK with the provided options
type SDKOption ¶
type SDKOption func(*Northflank)
func WithClient ¶
func WithClient(client HTTPClient) SDKOption
WithClient allows the overriding of the default HTTP client used by the SDK
func WithRetryConfig ¶ added in v1.3.0
func WithRetryConfig(retryConfig utils.RetryConfig) SDKOption
func WithSecurity ¶
func WithSecuritySource ¶ added in v1.5.0
WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication
func WithServerIndex ¶
WithServerIndex allows the overriding of the default server by index
func WithServerURL ¶
WithServerURL allows the overriding of the default server URL
Source Files ¶
Click to show internal directories.
Click to hide internal directories.