provideroptions

Documentation

Overview

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

Code generated by github.com/do87/stackit-client-generator version v0.0.2 DO NOT EDIT.

Index

• Constants
• func NewListRequest(ctx context.Context, server string) (*http.Request, error)
• type AvailabilityZone
• type CRI
• type CRIName
• type Client
  • func NewRawClient(server string, httpClient contracts.BaseClientInterface) *Client
  • func (c *Client) ListRaw(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
• type ClientWithResponses
  • func NewClient(server string, httpClient contracts.BaseClientInterface) *ClientWithResponses
  • func (c *ClientWithResponses) List(ctx context.Context, reqEditors ...RequestEditorFn) (*ListResponse, error)
  • func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)
• type ClientWithResponsesInterface
• type KubernetesVersion
• type ListResponse
  • func (r ListResponse) Status() string
  • func (r ListResponse) StatusCode() int
• type MachineImage
• type MachineImageVersion
• type MachineType
• type ProviderOptions
• type RequestEditorFn
• type RuntimeError
• type RuntimeErrorCode
• type VolumeType

Constants

const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Functions

func NewListRequest

func NewListRequest(ctx context.Context, server string) (*http.Request, error)

NewListRequest generates requests for List

Types

type AvailabilityZone

type AvailabilityZone struct {
	Name *string `json:"name,omitempty"`
}

AvailabilityZone defines model for AvailabilityZone.

type CRI

type CRI struct {
	Name *CRIName `json:"name,omitempty"`
}

CRI defines model for CRI.

type CRIName

type CRIName string

CRIName defines model for CRI.Name.

const (
	CONTAINERD CRIName = "containerd"
	DOCKER     CRIName = "docker"
)

Defines values for CRIName.

type Client

type Client struct {
	// 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 contracts.BaseClientInterface
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient(server string, httpClient contracts.BaseClientInterface) *Client

NewRawClient Creates a new Client, with reasonable defaults

func (*Client) ListRaw

func (c *Client) ListRaw(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientWithResponses

type ClientWithResponses struct {
	// contains filtered or unexported fields
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

func NewClient(server string, httpClient contracts.BaseClientInterface) *ClientWithResponses

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

func (*ClientWithResponses) List

func (c *ClientWithResponses) List(ctx context.Context, reqEditors ...RequestEditorFn) (*ListResponse, error)

List request returning *ListResponse

func (*ClientWithResponses) ParseListResponse

func (c *ClientWithResponses) ParseListResponse(rsp *http.Response) (*ListResponse, error)

ParseListResponse parses an HTTP response from a List call

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// List request
	List(ctx context.Context, reqEditors ...RequestEditorFn) (*ListResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type KubernetesVersion

type KubernetesVersion struct {
	ExpirationDate *string            `json:"expirationDate,omitempty"`
	FeatureGates   *map[string]string `json:"featureGates,omitempty"`
	State          *string            `json:"state,omitempty"`
	Version        *string            `json:"version,omitempty"`
}

KubernetesVersion defines model for KubernetesVersion.

type ListResponse

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ProviderOptions
	JSONDefault  *RuntimeError
	Error        error // Aggregated error
}

func (ListResponse) Status

func (r ListResponse) Status() string

Status returns HTTPResponse.Status

func (ListResponse) StatusCode

func (r ListResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type MachineImage

type MachineImage struct {
	Name     *string                `json:"name,omitempty"`
	Versions *[]MachineImageVersion `json:"versions,omitempty"`
}

MachineImage defines model for MachineImage.

type MachineImageVersion

type MachineImageVersion struct {
	CRI            *[]CRI  `json:"cri,omitempty"`
	ExpirationDate *string `json:"expirationDate,omitempty"`
	State          *string `json:"state,omitempty"`
	Version        *string `json:"version,omitempty"`
}

MachineImageVersion defines model for MachineImageVersion.

type MachineType

type MachineType struct {
	CPU    *int    `json:"cpu,omitempty"`
	Memory *int    `json:"memory,omitempty"`
	Name   *string `json:"name,omitempty"`
}

MachineType defines model for MachineType.

type ProviderOptions

type ProviderOptions struct {
	AvailabilityZones  *[]AvailabilityZone  `json:"availabilityZones,omitempty"`
	KubernetesVersions *[]KubernetesVersion `json:"kubernetesVersions,omitempty"`
	MachineImages      *[]MachineImage      `json:"machineImages,omitempty"`
	MachineTypes       *[]MachineType       `json:"machineTypes,omitempty"`
	VolumeTypes        *[]VolumeType        `json:"volumeTypes,omitempty"`
}

ProviderOptions defines model for ProviderOptions.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RuntimeError

type RuntimeError struct {
	// Code - Code:    "SKE_UNSPECIFIED"
	//   Message: "An error occurred. Please open a support ticket if this error persists."
	// - Code:    "SKE_TMP_AUTH_ERROR"
	//   Message: "Authentication failed. This is a temporary error. Please wait while the system recovers."
	// - Code:    "SKE_QUOTA_EXCEEDED"
	//   Message: "Your project's resource quotas are exhausted. Please make sure your quota is sufficient for the ordered cluster."
	// - Code:    "SKE_ARGUS_INSTANCE_NOT_FOUND"
	//   Message: "The provided Argus instance could not be found."
	// - Code:    "SKE_RATE_LIMITS"
	//   Message: "While provisioning your cluster, request rate limits where incurred. Please wait while the system recovers."
	// - Code:    "SKE_INFRA_ERROR"
	//   Message: "An error occurred with the underlying infrastructure. Please open a support ticket if this error persists."
	// - Code:    "SKE_REMAINING_RESOURCES"
	//   Message: "There are remaining Kubernetes resources in your cluster that prevent deletion. Please make sure to remove them."
	// - Code:    "SKE_CONFIGURATION_PROBLEM"
	//   Message: "A configuration error occurred. Please open a support ticket if this error persists."
	// - Code:    "SKE_UNREADY_NODES"
	//   Message: "Not all worker nodes are ready. Please open a support ticket if this error persists."
	// - Code:    "SKE_API_SERVER_ERROR"
	//   Message: "The Kubernetes API server is not reporting readiness. Please open a support ticket if this error persists."
	Code    *RuntimeErrorCode `json:"code,omitempty"`
	Details *string           `json:"details,omitempty"`
	Message *string           `json:"message,omitempty"`
}

RuntimeError defines model for RuntimeError.

type RuntimeErrorCode

type RuntimeErrorCode string

RuntimeErrorCode - Code: "SKE_UNSPECIFIED"

	Message: "An error occurred. Please open a support ticket if this error persists."
  - Code:    "SKE_TMP_AUTH_ERROR"
    Message: "Authentication failed. This is a temporary error. Please wait while the system recovers."
  - Code:    "SKE_QUOTA_EXCEEDED"
    Message: "Your project's resource quotas are exhausted. Please make sure your quota is sufficient for the ordered cluster."
  - Code:    "SKE_ARGUS_INSTANCE_NOT_FOUND"
    Message: "The provided Argus instance could not be found."
  - Code:    "SKE_RATE_LIMITS"
    Message: "While provisioning your cluster, request rate limits where incurred. Please wait while the system recovers."
  - Code:    "SKE_INFRA_ERROR"
    Message: "An error occurred with the underlying infrastructure. Please open a support ticket if this error persists."
  - Code:    "SKE_REMAINING_RESOURCES"
    Message: "There are remaining Kubernetes resources in your cluster that prevent deletion. Please make sure to remove them."
  - Code:    "SKE_CONFIGURATION_PROBLEM"
    Message: "A configuration error occurred. Please open a support ticket if this error persists."
  - Code:    "SKE_UNREADY_NODES"
    Message: "Not all worker nodes are ready. Please open a support ticket if this error persists."
  - Code:    "SKE_API_SERVER_ERROR"
    Message: "The Kubernetes API server is not reporting readiness. Please open a support ticket if this error persists."

const (
	SKE_API_SERVER_ERROR         RuntimeErrorCode = "SKE_API_SERVER_ERROR"
	SKE_ARGUS_INSTANCE_NOT_FOUND RuntimeErrorCode = "SKE_ARGUS_INSTANCE_NOT_FOUND"
	SKE_CONFIGURATION_PROBLEM    RuntimeErrorCode = "SKE_CONFIGURATION_PROBLEM"
	SKE_INFRA_ERROR              RuntimeErrorCode = "SKE_INFRA_ERROR"
	SKE_QUOTA_EXCEEDED           RuntimeErrorCode = "SKE_QUOTA_EXCEEDED"
	SKE_RATE_LIMITS              RuntimeErrorCode = "SKE_RATE_LIMITS"
	SKE_REMAINING_RESOURCES      RuntimeErrorCode = "SKE_REMAINING_RESOURCES"
	SKE_TMP_AUTH_ERROR           RuntimeErrorCode = "SKE_TMP_AUTH_ERROR"
	SKE_UNREADY_NODES            RuntimeErrorCode = "SKE_UNREADY_NODES"
	SKE_UNSPECIFIED              RuntimeErrorCode = "SKE_UNSPECIFIED"
)

Defines values for RuntimeErrorCode.

type VolumeType

type VolumeType struct {
	Name *string `json:"name,omitempty"`
}

VolumeType defines model for VolumeType.