Documentation ¶
Overview ¶
Package project 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 NewCreateProjectRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
- func NewDeleteProjectRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
- func NewGetProjectRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
- type Client
- func (c *Client) CreateProjectRaw(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) DeleteProjectRaw(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
- func (c *Client) GetProjectRaw(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*http.Response, error)
- type ClientWithResponses
- func (c *ClientWithResponses) CreateProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error)
- func (c *ClientWithResponses) DeleteProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteProjectResponse, error)
- func (c *ClientWithResponses) GetProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetProjectResponse, error)
- func (c *ClientWithResponses) ParseCreateProjectResponse(rsp *http.Response) (*CreateProjectResponse, error)
- func (c *ClientWithResponses) ParseDeleteProjectResponse(rsp *http.Response) (*DeleteProjectResponse, error)
- func (c *ClientWithResponses) ParseGetProjectResponse(rsp *http.Response) (*GetProjectResponse, error)
- type ClientWithResponsesInterface
- type CreateProjectResponse
- type DeleteProjectResponse
- type GetProjectResponse
- type Project
- type ProjectState
- type RequestEditorFn
- type RuntimeError
- type RuntimeErrorCode
Constants ¶
const (
BearerAuthScopes = "bearerAuth.Scopes"
)
Variables ¶
This section is empty.
Functions ¶
func NewCreateProjectRequest ¶
func NewCreateProjectRequest(ctx context.Context, server string, projectID string) (*http.Request, error)
NewCreateProjectRequest generates requests for CreateProject
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) CreateProjectRaw ¶
func (*Client) DeleteProjectRaw ¶
func (*Client) GetProjectRaw ¶
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) CreateProject ¶
func (c *ClientWithResponses) CreateProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error)
CreateProject request returning *CreateProjectResponse
func (*ClientWithResponses) DeleteProject ¶
func (c *ClientWithResponses) DeleteProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteProjectResponse, error)
DeleteProject request returning *DeleteProjectResponse
func (*ClientWithResponses) GetProject ¶
func (c *ClientWithResponses) GetProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetProjectResponse, error)
GetProject request returning *GetProjectResponse
func (*ClientWithResponses) ParseCreateProjectResponse ¶
func (c *ClientWithResponses) ParseCreateProjectResponse(rsp *http.Response) (*CreateProjectResponse, error)
ParseCreateProjectResponse parses an HTTP response from a CreateProject call
func (*ClientWithResponses) ParseDeleteProjectResponse ¶
func (c *ClientWithResponses) ParseDeleteProjectResponse(rsp *http.Response) (*DeleteProjectResponse, error)
ParseDeleteProjectResponse parses an HTTP response from a DeleteProject call
func (*ClientWithResponses) ParseGetProjectResponse ¶
func (c *ClientWithResponses) ParseGetProjectResponse(rsp *http.Response) (*GetProjectResponse, error)
ParseGetProjectResponse parses an HTTP response from a GetProject call
type ClientWithResponsesInterface ¶
type ClientWithResponsesInterface interface { // DeleteProject request DeleteProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*DeleteProjectResponse, error) // GetProject request GetProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*GetProjectResponse, error) // CreateProject request CreateProject(ctx context.Context, projectID string, reqEditors ...RequestEditorFn) (*CreateProjectResponse, error) }
ClientWithResponsesInterface is the interface specification for the client with responses above.
type CreateProjectResponse ¶
type CreateProjectResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Project JSON400 *map[string]interface{} JSONDefault *RuntimeError HasError error // Aggregated error }
func (CreateProjectResponse) Status ¶
func (r CreateProjectResponse) Status() string
Status returns HTTPResponse.Status
func (CreateProjectResponse) StatusCode ¶
func (r CreateProjectResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type DeleteProjectResponse ¶
type DeleteProjectResponse struct { Body []byte HTTPResponse *http.Response JSON200 *map[string]interface{} JSON202 *map[string]interface{} JSON400 *map[string]interface{} JSONDefault *RuntimeError HasError error // Aggregated error }
func (DeleteProjectResponse) Status ¶
func (r DeleteProjectResponse) Status() string
Status returns HTTPResponse.Status
func (DeleteProjectResponse) StatusCode ¶
func (r DeleteProjectResponse) StatusCode() int
StatusCode returns HTTPResponse.StatusCode
type GetProjectResponse ¶
type GetProjectResponse struct { Body []byte HTTPResponse *http.Response JSON200 *Project JSON404 *map[string]interface{} JSONDefault *RuntimeError HasError error // Aggregated error }
func (GetProjectResponse) Status ¶
func (r GetProjectResponse) Status() string
Status returns HTTPResponse.Status
func (GetProjectResponse) StatusCode ¶
func (r GetProjectResponse) 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 ¶
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.