credentials

package
v1.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package credentials 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

View Source
const (
	BearerAuthScopes = "bearerAuth.Scopes"
)

Variables

This section is empty.

Functions

func NewCompleteClusterCredentialsRotationRequest

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

NewCompleteClusterCredentialsRotationRequest generates requests for CompleteClusterCredentialsRotation

func NewCreateKubeconfigRequest

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

NewCreateKubeconfigRequest calls the generic CreateKubeconfig builder with application/json body

func NewCreateKubeconfigRequestWithBody

func NewCreateKubeconfigRequestWithBody(ctx context.Context, server string, projectID string, clusterName string, contentType string, body io.Reader) (*http.Request, error)

NewCreateKubeconfigRequestWithBody generates requests for CreateKubeconfig with any type of body

func NewListRequest

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

NewListRequest generates requests for List

func NewStartClusterCredentialsRotationRequest

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

NewStartClusterCredentialsRotationRequest generates requests for StartClusterCredentialsRotation

func NewTriggerRotationRequest

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

NewTriggerRotationRequest generates requests for TriggerRotation

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 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) CompleteClusterCredentialsRotationRaw

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

func (*Client) CreateKubeconfigRaw

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

func (*Client) CreateKubeconfigRawWithBody

func (c *Client) CreateKubeconfigRawWithBody(ctx context.Context, projectID string, clusterName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ListRaw

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

func (*Client) StartClusterCredentialsRotationRaw

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

func (*Client) TriggerRotationRaw

func (c *Client) TriggerRotationRaw(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 contracts.BaseClientInterface) *ClientWithResponses

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

func (*ClientWithResponses) CompleteClusterCredentialsRotation

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

CompleteClusterCredentialsRotation request returning *CompleteClusterCredentialsRotationResponse

func (*ClientWithResponses) CreateKubeconfig

func (c *ClientWithResponses) CreateKubeconfig(ctx context.Context, projectID string, clusterName string, body CreateKubeconfigJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateKubeconfigResponse, error)

func (*ClientWithResponses) CreateKubeconfigWithBody

func (c *ClientWithResponses) CreateKubeconfigWithBody(ctx context.Context, projectID string, clusterName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateKubeconfigResponse, error)

CreateKubeconfigWithBody request with arbitrary body returning *CreateKubeconfigResponse

func (*ClientWithResponses) List

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

List request returning *ListResponse

func (*ClientWithResponses) ParseCompleteClusterCredentialsRotationResponse

func (c *ClientWithResponses) ParseCompleteClusterCredentialsRotationResponse(rsp *http.Response) (*CompleteClusterCredentialsRotationResponse, error)

ParseCompleteClusterCredentialsRotationResponse parses an HTTP response from a CompleteClusterCredentialsRotation call

func (*ClientWithResponses) ParseCreateKubeconfigResponse

func (c *ClientWithResponses) ParseCreateKubeconfigResponse(rsp *http.Response) (*CreateKubeconfigResponse, error)

ParseCreateKubeconfigResponse parses an HTTP response from a CreateKubeconfig call

func (*ClientWithResponses) ParseListResponse

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

ParseListResponse parses an HTTP response from a List call

func (*ClientWithResponses) ParseStartClusterCredentialsRotationResponse

func (c *ClientWithResponses) ParseStartClusterCredentialsRotationResponse(rsp *http.Response) (*StartClusterCredentialsRotationResponse, error)

ParseStartClusterCredentialsRotationResponse parses an HTTP response from a StartClusterCredentialsRotation call

func (*ClientWithResponses) ParseTriggerRotationResponse

func (c *ClientWithResponses) ParseTriggerRotationResponse(rsp *http.Response) (*TriggerRotationResponse, error)

ParseTriggerRotationResponse parses an HTTP response from a TriggerRotation call

func (*ClientWithResponses) StartClusterCredentialsRotation

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

StartClusterCredentialsRotation request returning *StartClusterCredentialsRotationResponse

func (*ClientWithResponses) TriggerRotation

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

TriggerRotation request returning *TriggerRotationResponse

type ClientWithResponsesInterface

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

	// List request
	List(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*ListResponse, error)

	// CreateKubeconfig request with any body
	CreateKubeconfigWithBody(ctx context.Context, projectID string, clusterName string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*CreateKubeconfigResponse, error)

	CreateKubeconfig(ctx context.Context, projectID string, clusterName string, body CreateKubeconfigJSONRequestBody, reqEditors ...RequestEditorFn) (*CreateKubeconfigResponse, error)

	// TriggerRotation request
	TriggerRotation(ctx context.Context, projectID string, clusterName string, reqEditors ...RequestEditorFn) (*TriggerRotationResponse, error)

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

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

type CompleteClusterCredentialsRotationResponse

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

func (CompleteClusterCredentialsRotationResponse) Status

Status returns HTTPResponse.Status

func (CompleteClusterCredentialsRotationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type CreateKubeconfigJSONRequestBody

type CreateKubeconfigJSONRequestBody = KubeconfigRequest

CreateKubeconfigJSONRequestBody defines body for CreateKubeconfig for application/json ContentType.

type CreateKubeconfigResponse

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

func (CreateKubeconfigResponse) Status

func (r CreateKubeconfigResponse) Status() string

Status returns HTTPResponse.Status

func (CreateKubeconfigResponse) StatusCode

func (r CreateKubeconfigResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Credentials

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

	// Kubeconfig This string contains the kubeconfig as yaml.
	Kubeconfig *string `json:"kubeconfig,omitempty"`
	Server     *string `json:"server,omitempty"`
	Token      *string `json:"token,omitempty"`
}

Credentials defines model for Credentials.

type Kubeconfig

type Kubeconfig struct {
	ExpirationTimestamp *string `json:"expirationTimestamp,omitempty"`
	Kubeconfig          *string `json:"kubeconfig,omitempty"`
}

Kubeconfig defines model for Kubeconfig.

type KubeconfigRequest

type KubeconfigRequest struct {
	ExpirationSeconds *string `json:"expirationSeconds,omitempty"`
}

KubeconfigRequest defines model for KubeconfigRequest.

type ListResponse

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Credentials
	JSON400      *map[string]interface{}
	JSON404      *map[string]interface{}
	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 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 StartClusterCredentialsRotationResponse

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

func (StartClusterCredentialsRotationResponse) Status

Status returns HTTPResponse.Status

func (StartClusterCredentialsRotationResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type TriggerRotationResponse

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

func (TriggerRotationResponse) Status

func (r TriggerRotationResponse) Status() string

Status returns HTTPResponse.Status

func (TriggerRotationResponse) StatusCode

func (r TriggerRotationResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL