versions

Documentation

Overview

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

Code generated by dev.azure.com/schwarzit/schwarzit.odj.core/_git/stackit-client-generator.git version v1.0.23 DO NOT EDIT.

Index

• Constants
• func NewListRequest(ctx context.Context, server string, projectID string, params *ListParams) (*http.Request, error)
• type Client
  • func NewRawClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *Client[K]
  • func (c *Client[K]) ListRaw(ctx context.Context, projectID string, params *ListParams, ...) (*http.Response, error)
• type ClientWithResponses
  • func NewClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *ClientWithResponses[K]
  • func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, params *ListParams, ...) (*ListResponse, error)
  • func (c *ClientWithResponses[K]) ParseListResponse(rsp *http.Response) (*ListResponse, error)
• type ClientWithResponsesInterface
• type InstanceError
• type InstanceGetVersionsResponse
• type ListParams
• type ListResponse
  • func (r ListResponse) Status() string
  • func (r ListResponse) StatusCode() int
• type RequestEditorFn

Constants

const (
	BearerAuthScopes = "BearerAuth.Scopes"
)

Functions

func NewListRequest

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

NewListRequest generates requests for List

Types

type Client

type Client[K contracts.ClientFlowConfig] 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.ClientInterface[K]
}

Client which conforms to the OpenAPI3 specification for this service.

func NewRawClient

func NewRawClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *Client[K]

NewRawClient Creates a new Client, with reasonable defaults

func (*Client[K]) ListRaw

func (c *Client[K]) ListRaw(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientWithResponses

type ClientWithResponses[K contracts.ClientFlowConfig] struct {
	// contains filtered or unexported fields
}

ClientWithResponses builds on rawClientInterface to offer response payloads

func NewClient

func NewClient[K contracts.ClientFlowConfig](server string, httpClient contracts.ClientInterface[K]) *ClientWithResponses[K]

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

func (*ClientWithResponses[K]) List

func (c *ClientWithResponses[K]) List(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*ListResponse, error)

List request returning *ListResponse

func (*ClientWithResponses[K]) ParseListResponse

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

ParseListResponse parses an HTTP response from a List call

type ClientWithResponsesInterface

type ClientWithResponsesInterface[K contracts.ClientFlowConfig] interface {
	// List request
	List(ctx context.Context, projectID string, params *ListParams, reqEditors ...RequestEditorFn) (*ListResponse, error)
}

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

type InstanceError

type InstanceError struct {
	Code    *int                 `json:"code,omitempty"`
	Fields  *map[string][]string `json:"fields,omitempty"`
	Message *string              `json:"message,omitempty"`
	Type    *string              `json:"type,omitempty"`
}

InstanceError defines model for instance.Error.

type InstanceGetVersionsResponse

type InstanceGetVersionsResponse struct {
	Versions *[]string `json:"versions,omitempty"`
}

InstanceGetVersionsResponse defines model for instance.GetVersionsResponse.

type ListParams

type ListParams struct {
	// InstanceID Instance ID
	InstanceID *string `form:"instanceID,omitempty" json:"instanceID,omitempty"`
}

ListParams defines parameters for List.

type ListResponse

type ListResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *InstanceGetVersionsResponse
	JSON400      *InstanceError
	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