project

package
v1.29.11 Latest Latest
Warning

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

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

Documentation

Overview

Package project 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 NewCreateRequest 

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

NewCreateRequest generates requests for Create

func NewDeleteRequest 

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

NewDeleteRequest generates requests for Delete

func NewGetRequest 

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

NewGetRequest generates requests for Get

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

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

func (*Client) DeleteRaw 

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

func (*Client) GetRaw 

func (c *Client) GetRaw(ctx context.Context, projectID 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) Create 

func (c *ClientWithResponses) Create(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateResponse, error)

Create request returning *CreateResponse

func (*ClientWithResponses) Delete 

func (c *ClientWithResponses) Delete(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

Delete request returning *DeleteResponse

func (*ClientWithResponses) Get 

func (c *ClientWithResponses) Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)

Get request returning *GetResponse

func (*ClientWithResponses) ParseCreateResponse 

func (c *ClientWithResponses) ParseCreateResponse(rsp *http.Response) (*CreateResponse, error)

ParseCreateResponse parses an HTTP response from a Create call

func (*ClientWithResponses) ParseDeleteResponse 

func (c *ClientWithResponses) ParseDeleteResponse(rsp *http.Response) (*DeleteResponse, error)

ParseDeleteResponse parses an HTTP response from a Delete call

func (*ClientWithResponses) ParseGetResponse 

func (c *ClientWithResponses) ParseGetResponse(rsp *http.Response) (*GetResponse, error)

ParseGetResponse parses an HTTP response from a Get call

type ClientWithResponsesInterface 

type ClientWithResponsesInterface interface {
	// Delete request
	Delete(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteResponse, error)

	// Get request
	Get(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetResponse, error)

	// Create request
	Create(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateResponse, error)
}

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

type CreateResponse 

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

func (CreateResponse) Status 

func (r CreateResponse) Status() string

Status returns HTTPResponse.Status

func (CreateResponse) StatusCode 

func (r CreateResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

func (*CreateResponse) WaitHandler 

func (*CreateResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID string) *wait.Handler

type DeleteResponse 

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

func (DeleteResponse) Status 

func (r DeleteResponse) Status() string

Status returns HTTPResponse.Status

func (DeleteResponse) StatusCode 

func (r DeleteResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

func (*DeleteResponse) WaitHandler 

func (*DeleteResponse) WaitHandler(ctx context.Context, c *ClientWithResponses, projectID string) *wait.Handler

type GetResponse 

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

func (GetResponse) Status 

func (r GetResponse) Status() string

Status returns HTTPResponse.Status

func (GetResponse) StatusCode 

func (r GetResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Project 

type Project struct {
	ProjectID *string       `json:"projectId,omitempty"`
	State     *ProjectState `json:"state,omitempty"`
}

Project defines model for Project.

type ProjectState 

type ProjectState string

ProjectState defines model for ProjectState. 

const (
	STATE_CREATED     ProjectState = "STATE_CREATED"
	STATE_CREATING    ProjectState = "STATE_CREATING"
	STATE_DELETING    ProjectState = "STATE_DELETING"
	STATE_FAILED      ProjectState = "STATE_FAILED"
	STATE_UNSPECIFIED ProjectState = "STATE_UNSPECIFIED"
)

Defines values for ProjectState.

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.