credentials

Documentation

Overview

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

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

Index

• Constants
• func NewGetClusterCredentialsRequest(ctx context.Context, server string, projectID string, clusterName string) (*http.Request, error)
• func NewTriggerClusterCredentialRotationRequest(ctx context.Context, server string, projectID string, clusterName string) (*http.Request, error)
• type Client
  • func NewRawClient(server string, httpClient skeclient.HttpRequestDoer) *Client
  • func (c *Client) GetClusterCredentialsRaw(ctx context.Context, projectID string, clusterName string, ...) (*http.Response, error)
  • func (c *Client) TriggerClusterCredentialRotationRaw(ctx context.Context, projectID string, clusterName string, ...) (*http.Response, error)
• type ClientWithResponses
  • func NewClient(server string, httpClient skeclient.HttpRequestDoer) *ClientWithResponses
  • func (c *ClientWithResponses) GetClusterCredentials(ctx context.Context, projectID string, clusterName string, ...) (*GetClusterCredentialsResponse, error)
  • func (c *ClientWithResponses) ParseGetClusterCredentialsResponse(rsp *http.Response) (*GetClusterCredentialsResponse, error)
  • func (c *ClientWithResponses) ParseTriggerClusterCredentialRotationResponse(rsp *http.Response) (*TriggerClusterCredentialRotationResponse, error)
  • func (c *ClientWithResponses) TriggerClusterCredentialRotation(ctx context.Context, projectID string, clusterName string, ...) (*TriggerClusterCredentialRotationResponse, error)
• type ClientWithResponsesInterface
• type Credentials
• type GetClusterCredentialsResponse
  • func (r GetClusterCredentialsResponse) Status() string
  • func (r GetClusterCredentialsResponse) StatusCode() int
• type RequestEditorFn
• type RuntimeError
• type RuntimeErrorCode
• type TriggerClusterCredentialRotationResponse
  • func (r TriggerClusterCredentialRotationResponse) Status() string
  • func (r TriggerClusterCredentialRotationResponse) StatusCode() int

Constants

const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Functions

func NewGetClusterCredentialsRequest

func NewGetClusterCredentialsRequest(ctx context.Context, server string, projectID string, clusterName string) (*http.Request, error)

NewGetClusterCredentialsRequest generates requests for GetClusterCredentials

func NewTriggerClusterCredentialRotationRequest

func NewTriggerClusterCredentialRotationRequest(ctx context.Context, server string, projectID string, clusterName string) (*http.Request, error)

NewTriggerClusterCredentialRotationRequest generates requests for TriggerClusterCredentialRotation

Types

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 skeclient.HttpRequestDoer
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient(server string, httpClient skeclient.HttpRequestDoer) *Client

NewRawClient Creates a new Client, with reasonable defaults

func (*Client) GetClusterCredentialsRaw

func (c *Client) GetClusterCredentialsRaw(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) TriggerClusterCredentialRotationRaw

func (c *Client) TriggerClusterCredentialRotationRaw(ctx context.Context, projectID string, clusterName string, 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 skeclient.HttpRequestDoer) *ClientWithResponses

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

func (*ClientWithResponses) GetClusterCredentials

func (c *ClientWithResponses) GetClusterCredentials(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*GetClusterCredentialsResponse, error)

GetClusterCredentials request returning *GetClusterCredentialsResponse

func (*ClientWithResponses) ParseGetClusterCredentialsResponse

func (c *ClientWithResponses) ParseGetClusterCredentialsResponse(rsp *http.Response) (*GetClusterCredentialsResponse, error)

ParseGetClusterCredentialsResponse parses an HTTP response from a GetClusterCredentials call

func (*ClientWithResponses) ParseTriggerClusterCredentialRotationResponse

func (c *ClientWithResponses) ParseTriggerClusterCredentialRotationResponse(rsp *http.Response) (*TriggerClusterCredentialRotationResponse, error)

ParseTriggerClusterCredentialRotationResponse parses an HTTP response from a TriggerClusterCredentialRotation call

func (*ClientWithResponses) TriggerClusterCredentialRotation

func (c *ClientWithResponses) TriggerClusterCredentialRotation(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*TriggerClusterCredentialRotationResponse, error)

TriggerClusterCredentialRotation request returning *TriggerClusterCredentialRotationResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetClusterCredentials request
	GetClusterCredentials(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*GetClusterCredentialsResponse, error)

	// TriggerClusterCredentialRotation request
	TriggerClusterCredentialRotation(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*TriggerClusterCredentialRotationResponse, error)
}

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

type Credentials

type Credentials struct {
	CertificateAuthorityData *string `json:"certificateAuthorityData,omitempty"`

	// Kubeconfig This string contains the kubeconfig as yaml. If you want to directly get the yaml without any
	//  characters you can use the following command: curl -s 'api.stackit.cloud/ske/v1/projects/{projectId}/clusters/{clusterName}/credentials' |jq -r .kubeconfig
	Kubeconfig *string `json:"kubeconfig,omitempty"`
	Server     *string `json:"server,omitempty"`
	Token      *string `json:"token,omitempty"`
}

Credentials defines model for Credentials.

type GetClusterCredentialsResponse

type GetClusterCredentialsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Credentials
	JSON400      *map[string]interface{}
	JSON404      *map[string]interface{}
	JSONDefault  *RuntimeError
	HasError     error // Aggregated error
}

func (GetClusterCredentialsResponse) Status

func (r GetClusterCredentialsResponse) Status() string

Status returns HTTPResponse.Status

func (GetClusterCredentialsResponse) StatusCode

func (r GetClusterCredentialsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

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_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_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_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 TriggerClusterCredentialRotationResponse

type TriggerClusterCredentialRotationResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *map[string]interface{}
	JSON202      *map[string]interface{}
	JSON404      *map[string]interface{}
	JSONDefault  *RuntimeError
	HasError     error // Aggregated error
}

func (TriggerClusterCredentialRotationResponse) Status

func (r TriggerClusterCredentialRotationResponse) Status() string

Status returns HTTPResponse.Status

func (TriggerClusterCredentialRotationResponse) StatusCode

func (r TriggerClusterCredentialRotationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode