api

package
v0.0.0-...-74ad9c3 Latest Latest
Warning

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

Go to latest
Published: May 19, 2025 License: GPL-3.0 Imports: 10 Imported by: 0

Documentation

Overview

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

Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.4.1 DO NOT EDIT.

Index

Constants

View Source
const (
	TokenHeaderScopes = "tokenHeader.Scopes"
	TokenParamScopes  = "tokenParam.Scopes"
)

Variables

This section is empty.

Functions

func NewDeleteApiKernelsKernelIdRequest

func NewDeleteApiKernelsKernelIdRequest(server string, kernelId openapi_types.UUID) (*http.Request, error)

NewDeleteApiKernelsKernelIdRequest generates requests for DeleteApiKernelsKernelId

func NewDeleteApiSessionsSessionRequest

func NewDeleteApiSessionsSessionRequest(server string, session openapi_types.UUID) (*http.Request, error)

NewDeleteApiSessionsSessionRequest generates requests for DeleteApiSessionsSession

func NewGetApiKernelsKernelIdChannelsRequest

func NewGetApiKernelsKernelIdChannelsRequest(server string, kernelId openapi_types.UUID) (*http.Request, error)

NewGetApiKernelsKernelIdChannelsRequest generates requests for GetApiKernelsKernelIdChannels

func NewGetApiKernelsKernelIdRequest

func NewGetApiKernelsKernelIdRequest(server string, kernelId openapi_types.UUID) (*http.Request, error)

NewGetApiKernelsKernelIdRequest generates requests for GetApiKernelsKernelId

func NewGetApiKernelsRequest

func NewGetApiKernelsRequest(server string) (*http.Request, error)

NewGetApiKernelsRequest generates requests for GetApiKernels

func NewGetApiKernelspecsRequest

func NewGetApiKernelspecsRequest(server string, params *GetApiKernelspecsParams) (*http.Request, error)

NewGetApiKernelspecsRequest generates requests for GetApiKernelspecs

func NewGetApiRequest

func NewGetApiRequest(server string) (*http.Request, error)

NewGetApiRequest generates requests for GetApi

func NewGetApiSessionsRequest

func NewGetApiSessionsRequest(server string) (*http.Request, error)

NewGetApiSessionsRequest generates requests for GetApiSessions

func NewGetApiSessionsSessionRequest

func NewGetApiSessionsSessionRequest(server string, session openapi_types.UUID) (*http.Request, error)

NewGetApiSessionsSessionRequest generates requests for GetApiSessionsSession

func NewGetApiSwaggerJsonRequest

func NewGetApiSwaggerJsonRequest(server string) (*http.Request, error)

NewGetApiSwaggerJsonRequest generates requests for GetApiSwaggerJson

func NewGetApiSwaggerYamlRequest

func NewGetApiSwaggerYamlRequest(server string) (*http.Request, error)

NewGetApiSwaggerYamlRequest generates requests for GetApiSwaggerYaml

func NewPatchApiSessionsSessionRequest

func NewPatchApiSessionsSessionRequest(server string, session openapi_types.UUID, body PatchApiSessionsSessionJSONRequestBody) (*http.Request, error)

NewPatchApiSessionsSessionRequest calls the generic PatchApiSessionsSession builder with application/json body

func NewPatchApiSessionsSessionRequestWithBody

func NewPatchApiSessionsSessionRequestWithBody(server string, session openapi_types.UUID, contentType string, body io.Reader) (*http.Request, error)

NewPatchApiSessionsSessionRequestWithBody generates requests for PatchApiSessionsSession with any type of body

func NewPostApiKernelsRequest

func NewPostApiKernelsRequest(server string, body PostApiKernelsJSONRequestBody) (*http.Request, error)

NewPostApiKernelsRequest calls the generic PostApiKernels builder with application/json body

func NewPostApiKernelsRequestWithBody

func NewPostApiKernelsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiKernelsRequestWithBody generates requests for PostApiKernels with any type of body

func NewPostApiSessionsRequest

func NewPostApiSessionsRequest(server string, body PostApiSessionsJSONRequestBody) (*http.Request, error)

NewPostApiSessionsRequest calls the generic PostApiSessions builder with application/json body

func NewPostApiSessionsRequestWithBody

func NewPostApiSessionsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostApiSessionsRequestWithBody generates requests for PostApiSessions with any type of body

func NewPostKernelsKernelIdInterruptRequest

func NewPostKernelsKernelIdInterruptRequest(server string, kernelId openapi_types.UUID) (*http.Request, error)

NewPostKernelsKernelIdInterruptRequest generates requests for PostKernelsKernelIdInterrupt

func NewPostKernelsKernelIdRestartRequest

func NewPostKernelsKernelIdRestartRequest(server string, kernelId openapi_types.UUID) (*http.Request, error)

NewPostKernelsKernelIdRestartRequest generates requests for PostKernelsKernelIdRestart

Types

type ApiInfo

type ApiInfo struct {
	GatewayVersion *string `json:"gateway_version,omitempty"`
	Version        *string `json:"version,omitempty"`
}

ApiInfo Information about the api

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 HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) DeleteApiKernelsKernelId

func (c *Client) DeleteApiKernelsKernelId(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) DeleteApiSessionsSession

func (c *Client) DeleteApiSessionsSession(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApi

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

func (*Client) GetApiKernels

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

func (*Client) GetApiKernelsKernelId

func (c *Client) GetApiKernelsKernelId(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiKernelsKernelIdChannels

func (c *Client) GetApiKernelsKernelIdChannels(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiKernelspecs

func (c *Client) GetApiKernelspecs(ctx context.Context, params *GetApiKernelspecsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiSessions

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

func (*Client) GetApiSessionsSession

func (c *Client) GetApiSessionsSession(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) GetApiSwaggerJson

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

func (*Client) GetApiSwaggerYaml

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

func (*Client) PatchApiSessionsSession

func (c *Client) PatchApiSessionsSession(ctx context.Context, session openapi_types.UUID, body PatchApiSessionsSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PatchApiSessionsSessionWithBody

func (c *Client) PatchApiSessionsSessionWithBody(ctx context.Context, session openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiKernels

func (c *Client) PostApiKernels(ctx context.Context, body PostApiKernelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiKernelsWithBody

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

func (*Client) PostApiSessions

func (c *Client) PostApiSessions(ctx context.Context, body PostApiSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostApiSessionsWithBody

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

func (*Client) PostKernelsKernelIdInterrupt

func (c *Client) PostKernelsKernelIdInterrupt(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostKernelsKernelIdRestart

func (c *Client) PostKernelsKernelIdRestart(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// GetApi request
	GetApi(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKernels request
	GetApiKernels(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiKernelsWithBody request with any body
	PostApiKernelsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiKernels(ctx context.Context, body PostApiKernelsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiKernelsKernelId request
	DeleteApiKernelsKernelId(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKernelsKernelId request
	GetApiKernelsKernelId(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKernelsKernelIdChannels request
	GetApiKernelsKernelIdChannels(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiKernelspecs request
	GetApiKernelspecs(ctx context.Context, params *GetApiKernelspecsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSessions request
	GetApiSessions(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostApiSessionsWithBody request with any body
	PostApiSessionsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostApiSessions(ctx context.Context, body PostApiSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// DeleteApiSessionsSession request
	DeleteApiSessionsSession(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSessionsSession request
	GetApiSessionsSession(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PatchApiSessionsSessionWithBody request with any body
	PatchApiSessionsSessionWithBody(ctx context.Context, session openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PatchApiSessionsSession(ctx context.Context, session openapi_types.UUID, body PatchApiSessionsSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSwaggerJson request
	GetApiSwaggerJson(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetApiSwaggerYaml request
	GetApiSwaggerYaml(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostKernelsKernelIdInterrupt request
	PostKernelsKernelIdInterrupt(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)

	// PostKernelsKernelIdRestart request
	PostKernelsKernelIdRestart(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

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

func (*ClientWithResponses) DeleteApiKernelsKernelIdWithResponse

func (c *ClientWithResponses) DeleteApiKernelsKernelIdWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteApiKernelsKernelIdResponse, error)

DeleteApiKernelsKernelIdWithResponse request returning *DeleteApiKernelsKernelIdResponse

func (*ClientWithResponses) DeleteApiSessionsSessionWithResponse

func (c *ClientWithResponses) DeleteApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteApiSessionsSessionResponse, error)

DeleteApiSessionsSessionWithResponse request returning *DeleteApiSessionsSessionResponse

func (*ClientWithResponses) GetApiKernelsKernelIdChannelsWithResponse

func (c *ClientWithResponses) GetApiKernelsKernelIdChannelsWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiKernelsKernelIdChannelsResponse, error)

GetApiKernelsKernelIdChannelsWithResponse request returning *GetApiKernelsKernelIdChannelsResponse

func (*ClientWithResponses) GetApiKernelsKernelIdWithResponse

func (c *ClientWithResponses) GetApiKernelsKernelIdWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiKernelsKernelIdResponse, error)

GetApiKernelsKernelIdWithResponse request returning *GetApiKernelsKernelIdResponse

func (*ClientWithResponses) GetApiKernelsWithResponse

func (c *ClientWithResponses) GetApiKernelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiKernelsResponse, error)

GetApiKernelsWithResponse request returning *GetApiKernelsResponse

func (*ClientWithResponses) GetApiKernelspecsWithResponse

func (c *ClientWithResponses) GetApiKernelspecsWithResponse(ctx context.Context, params *GetApiKernelspecsParams, reqEditors ...RequestEditorFn) (*GetApiKernelspecsResponse, error)

GetApiKernelspecsWithResponse request returning *GetApiKernelspecsResponse

func (*ClientWithResponses) GetApiSessionsSessionWithResponse

func (c *ClientWithResponses) GetApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiSessionsSessionResponse, error)

GetApiSessionsSessionWithResponse request returning *GetApiSessionsSessionResponse

func (*ClientWithResponses) GetApiSessionsWithResponse

func (c *ClientWithResponses) GetApiSessionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSessionsResponse, error)

GetApiSessionsWithResponse request returning *GetApiSessionsResponse

func (*ClientWithResponses) GetApiSwaggerJsonWithResponse

func (c *ClientWithResponses) GetApiSwaggerJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSwaggerJsonResponse, error)

GetApiSwaggerJsonWithResponse request returning *GetApiSwaggerJsonResponse

func (*ClientWithResponses) GetApiSwaggerYamlWithResponse

func (c *ClientWithResponses) GetApiSwaggerYamlWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSwaggerYamlResponse, error)

GetApiSwaggerYamlWithResponse request returning *GetApiSwaggerYamlResponse

func (*ClientWithResponses) GetApiWithResponse

func (c *ClientWithResponses) GetApiWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiResponse, error)

GetApiWithResponse request returning *GetApiResponse

func (*ClientWithResponses) PatchApiSessionsSessionWithBodyWithResponse

func (c *ClientWithResponses) PatchApiSessionsSessionWithBodyWithResponse(ctx context.Context, session openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchApiSessionsSessionResponse, error)

PatchApiSessionsSessionWithBodyWithResponse request with arbitrary body returning *PatchApiSessionsSessionResponse

func (*ClientWithResponses) PatchApiSessionsSessionWithResponse

func (c *ClientWithResponses) PatchApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, body PatchApiSessionsSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchApiSessionsSessionResponse, error)

func (*ClientWithResponses) PostApiKernelsWithBodyWithResponse

func (c *ClientWithResponses) PostApiKernelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiKernelsResponse, error)

PostApiKernelsWithBodyWithResponse request with arbitrary body returning *PostApiKernelsResponse

func (*ClientWithResponses) PostApiKernelsWithResponse

func (c *ClientWithResponses) PostApiKernelsWithResponse(ctx context.Context, body PostApiKernelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiKernelsResponse, error)

func (*ClientWithResponses) PostApiSessionsWithBodyWithResponse

func (c *ClientWithResponses) PostApiSessionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSessionsResponse, error)

PostApiSessionsWithBodyWithResponse request with arbitrary body returning *PostApiSessionsResponse

func (*ClientWithResponses) PostApiSessionsWithResponse

func (c *ClientWithResponses) PostApiSessionsWithResponse(ctx context.Context, body PostApiSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSessionsResponse, error)

func (*ClientWithResponses) PostKernelsKernelIdInterruptWithResponse

func (c *ClientWithResponses) PostKernelsKernelIdInterruptWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*PostKernelsKernelIdInterruptResponse, error)

PostKernelsKernelIdInterruptWithResponse request returning *PostKernelsKernelIdInterruptResponse

func (*ClientWithResponses) PostKernelsKernelIdRestartWithResponse

func (c *ClientWithResponses) PostKernelsKernelIdRestartWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*PostKernelsKernelIdRestartResponse, error)

PostKernelsKernelIdRestartWithResponse request returning *PostKernelsKernelIdRestartResponse

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// GetApiWithResponse request
	GetApiWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiResponse, error)

	// GetApiKernelsWithResponse request
	GetApiKernelsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiKernelsResponse, error)

	// PostApiKernelsWithBodyWithResponse request with any body
	PostApiKernelsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiKernelsResponse, error)

	PostApiKernelsWithResponse(ctx context.Context, body PostApiKernelsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiKernelsResponse, error)

	// DeleteApiKernelsKernelIdWithResponse request
	DeleteApiKernelsKernelIdWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteApiKernelsKernelIdResponse, error)

	// GetApiKernelsKernelIdWithResponse request
	GetApiKernelsKernelIdWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiKernelsKernelIdResponse, error)

	// GetApiKernelsKernelIdChannelsWithResponse request
	GetApiKernelsKernelIdChannelsWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiKernelsKernelIdChannelsResponse, error)

	// GetApiKernelspecsWithResponse request
	GetApiKernelspecsWithResponse(ctx context.Context, params *GetApiKernelspecsParams, reqEditors ...RequestEditorFn) (*GetApiKernelspecsResponse, error)

	// GetApiSessionsWithResponse request
	GetApiSessionsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSessionsResponse, error)

	// PostApiSessionsWithBodyWithResponse request with any body
	PostApiSessionsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostApiSessionsResponse, error)

	PostApiSessionsWithResponse(ctx context.Context, body PostApiSessionsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostApiSessionsResponse, error)

	// DeleteApiSessionsSessionWithResponse request
	DeleteApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*DeleteApiSessionsSessionResponse, error)

	// GetApiSessionsSessionWithResponse request
	GetApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, reqEditors ...RequestEditorFn) (*GetApiSessionsSessionResponse, error)

	// PatchApiSessionsSessionWithBodyWithResponse request with any body
	PatchApiSessionsSessionWithBodyWithResponse(ctx context.Context, session openapi_types.UUID, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PatchApiSessionsSessionResponse, error)

	PatchApiSessionsSessionWithResponse(ctx context.Context, session openapi_types.UUID, body PatchApiSessionsSessionJSONRequestBody, reqEditors ...RequestEditorFn) (*PatchApiSessionsSessionResponse, error)

	// GetApiSwaggerJsonWithResponse request
	GetApiSwaggerJsonWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSwaggerJsonResponse, error)

	// GetApiSwaggerYamlWithResponse request
	GetApiSwaggerYamlWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*GetApiSwaggerYamlResponse, error)

	// PostKernelsKernelIdInterruptWithResponse request
	PostKernelsKernelIdInterruptWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*PostKernelsKernelIdInterruptResponse, error)

	// PostKernelsKernelIdRestartWithResponse request
	PostKernelsKernelIdRestartWithResponse(ctx context.Context, kernelId openapi_types.UUID, reqEditors ...RequestEditorFn) (*PostKernelsKernelIdRestartResponse, error)
}

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

type DeleteApiKernelsKernelIdResponse

type DeleteApiKernelsKernelIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteApiKernelsKernelIdResponse

func ParseDeleteApiKernelsKernelIdResponse(rsp *http.Response) (*DeleteApiKernelsKernelIdResponse, error)

ParseDeleteApiKernelsKernelIdResponse parses an HTTP response from a DeleteApiKernelsKernelIdWithResponse call

func (DeleteApiKernelsKernelIdResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiKernelsKernelIdResponse) StatusCode

func (r DeleteApiKernelsKernelIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type DeleteApiSessionsSessionResponse

type DeleteApiSessionsSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseDeleteApiSessionsSessionResponse

func ParseDeleteApiSessionsSessionResponse(rsp *http.Response) (*DeleteApiSessionsSessionResponse, error)

ParseDeleteApiSessionsSessionResponse parses an HTTP response from a DeleteApiSessionsSessionWithResponse call

func (DeleteApiSessionsSessionResponse) Status

Status returns HTTPResponse.Status

func (DeleteApiSessionsSessionResponse) StatusCode

func (r DeleteApiSessionsSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type Error

type Error struct {
	// Message The message logged when the error occurred
	Message *string `json:"message,omitempty"`

	// Reason The reason for the failure
	Reason *string `json:"reason,omitempty"`
}

Error An error response from the server

type GetApiKernelsKernelIdChannelsResponse

type GetApiKernelsKernelIdChannelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseGetApiKernelsKernelIdChannelsResponse

func ParseGetApiKernelsKernelIdChannelsResponse(rsp *http.Response) (*GetApiKernelsKernelIdChannelsResponse, error)

ParseGetApiKernelsKernelIdChannelsResponse parses an HTTP response from a GetApiKernelsKernelIdChannelsWithResponse call

func (GetApiKernelsKernelIdChannelsResponse) Status

Status returns HTTPResponse.Status

func (GetApiKernelsKernelIdChannelsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type GetApiKernelsKernelIdResponse

type GetApiKernelsKernelIdResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Kernel
}

func ParseGetApiKernelsKernelIdResponse

func ParseGetApiKernelsKernelIdResponse(rsp *http.Response) (*GetApiKernelsKernelIdResponse, error)

ParseGetApiKernelsKernelIdResponse parses an HTTP response from a GetApiKernelsKernelIdWithResponse call

func (GetApiKernelsKernelIdResponse) Status

Status returns HTTPResponse.Status

func (GetApiKernelsKernelIdResponse) StatusCode

func (r GetApiKernelsKernelIdResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiKernelsResponse

type GetApiKernelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Kernel
	JSON403      *Error
}

func ParseGetApiKernelsResponse

func ParseGetApiKernelsResponse(rsp *http.Response) (*GetApiKernelsResponse, error)

ParseGetApiKernelsResponse parses an HTTP response from a GetApiKernelsWithResponse call

func (GetApiKernelsResponse) Status

func (r GetApiKernelsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiKernelsResponse) StatusCode

func (r GetApiKernelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiKernelspecsParams

type GetApiKernelspecsParams struct {
	// User When present, kernelspec results will be filtered based on the configured authorization of specified value.
	User *string `form:"user,omitempty" json:"user,omitempty"`
}

GetApiKernelspecsParams defines parameters for GetApiKernelspecs.

type GetApiKernelspecsResponse

type GetApiKernelspecsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *struct {
		// Default The name of the default kernel.
		Default     *string                `json:"default,omitempty"`
		Kernelspecs *map[string]KernelSpec `json:"kernelspecs,omitempty"`
	}
}

func ParseGetApiKernelspecsResponse

func ParseGetApiKernelspecsResponse(rsp *http.Response) (*GetApiKernelspecsResponse, error)

ParseGetApiKernelspecsResponse parses an HTTP response from a GetApiKernelspecsWithResponse call

func (GetApiKernelspecsResponse) Status

func (r GetApiKernelspecsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiKernelspecsResponse) StatusCode

func (r GetApiKernelspecsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiResponse

type GetApiResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ApiInfo
}

func ParseGetApiResponse

func ParseGetApiResponse(rsp *http.Response) (*GetApiResponse, error)

ParseGetApiResponse parses an HTTP response from a GetApiWithResponse call

func (GetApiResponse) Status

func (r GetApiResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiResponse) StatusCode

func (r GetApiResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSessionsResponse

type GetApiSessionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]Session
	JSON403      *Error
}

func ParseGetApiSessionsResponse

func ParseGetApiSessionsResponse(rsp *http.Response) (*GetApiSessionsResponse, error)

ParseGetApiSessionsResponse parses an HTTP response from a GetApiSessionsWithResponse call

func (GetApiSessionsResponse) Status

func (r GetApiSessionsResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiSessionsResponse) StatusCode

func (r GetApiSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSessionsSessionResponse

type GetApiSessionsSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Session
}

func ParseGetApiSessionsSessionResponse

func ParseGetApiSessionsSessionResponse(rsp *http.Response) (*GetApiSessionsSessionResponse, error)

ParseGetApiSessionsSessionResponse parses an HTTP response from a GetApiSessionsSessionWithResponse call

func (GetApiSessionsSessionResponse) Status

Status returns HTTPResponse.Status

func (GetApiSessionsSessionResponse) StatusCode

func (r GetApiSessionsSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSwaggerJsonResponse

type GetApiSwaggerJsonResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseGetApiSwaggerJsonResponse

func ParseGetApiSwaggerJsonResponse(rsp *http.Response) (*GetApiSwaggerJsonResponse, error)

ParseGetApiSwaggerJsonResponse parses an HTTP response from a GetApiSwaggerJsonWithResponse call

func (GetApiSwaggerJsonResponse) Status

func (r GetApiSwaggerJsonResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiSwaggerJsonResponse) StatusCode

func (r GetApiSwaggerJsonResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type GetApiSwaggerYamlResponse

type GetApiSwaggerYamlResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParseGetApiSwaggerYamlResponse

func ParseGetApiSwaggerYamlResponse(rsp *http.Response) (*GetApiSwaggerYamlResponse, error)

ParseGetApiSwaggerYamlResponse parses an HTTP response from a GetApiSwaggerYamlWithResponse call

func (GetApiSwaggerYamlResponse) Status

func (r GetApiSwaggerYamlResponse) Status() string

Status returns HTTPResponse.Status

func (GetApiSwaggerYamlResponse) StatusCode

func (r GetApiSwaggerYamlResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type Kernel

type Kernel struct {
	// Connections The number of active connections to this kernel.
	Connections *float32 `json:"connections,omitempty"`

	// ExecutionState Current execution state of the kernel (typically 'idle' or 'busy', but may be other values, such as 'starting').
	// Added in notebook server 5.0.
	ExecutionState *string `json:"execution_state,omitempty"`

	// Id uuid of kernel
	Id openapi_types.UUID `json:"id"`

	// LastActivity ISO 8601 timestamp for the last-seen activity on this kernel.
	// Use this in combination with execution_state == 'idle' to identify
	// which kernels have been idle since a given time.
	// Timestamps will be UTC, indicated 'Z' suffix.
	// Added in notebook server 5.0.
	LastActivity *string `json:"last_activity,omitempty"`

	// Name kernel spec name
	Name string `json:"name"`
}

Kernel Kernel information

type KernelSpec

type KernelSpec struct {
	// KernelSpecFile Kernel spec json file
	KernelSpecFile *KernelSpecFile `json:"KernelSpecFile,omitempty"`

	// Name Unique name for kernel
	Name      *string `json:"name,omitempty"`
	Resources *struct {
		// KernelCss path for kernel.css file
		KernelCss *string `json:"kernel.css,omitempty"`

		// KernelJs path for kernel.js file
		KernelJs *string `json:"kernel.js,omitempty"`

		// Logo path for logo file.  Logo filenames are of the form `logo-widthxheight`
		Logo *string `json:"logo-*,omitempty"`
	} `json:"resources,omitempty"`
}

KernelSpec Kernel spec (contents of kernel.json)

type KernelSpecFile

type KernelSpecFile struct {
	// Argv A list of command line arguments used to start the kernel. The text `{connection_file}` in any
	// argument will be replaced with the path to the connection file.
	Argv []string `json:"argv"`

	// CodemirrorMode Codemirror mode.  Can be a string *or* an valid Codemirror mode object.  This defaults to the
	// string from the `language` property.
	CodemirrorMode *string `json:"codemirror_mode,omitempty"`

	// DisplayName The kernel's name as it should be displayed in the UI. Unlike the kernel name used in the API,
	// this can contain arbitrary unicode characters.
	DisplayName string `json:"display_name"`

	// Env A dictionary of environment variables to set for the kernel. These will be added to the current
	// environment variables.
	Env *map[string]string `json:"env,omitempty"`

	// HelpLinks Help items to be displayed in the help menu in the notebook UI.
	HelpLinks *[]struct {
		// Text menu item link text
		Text string `json:"text"`

		// Url menu item link url
		Url string `json:"url"`
	} `json:"help_links,omitempty"`

	// Language The programming language which this kernel runs. This will be stored in notebook metadata.
	Language string `json:"language"`

	// Metadata A free-form dictionary consisting of additional information about the kernel and its environment.
	Metadata *map[string]interface{} `json:"metadata,omitempty"`
}

KernelSpecFile Kernel spec json file

type PatchApiSessionsSessionJSONRequestBody

type PatchApiSessionsSessionJSONRequestBody = Session

PatchApiSessionsSessionJSONRequestBody defines body for PatchApiSessionsSession for application/json ContentType.

type PatchApiSessionsSessionResponse

type PatchApiSessionsSessionResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Session
	JSON400      *Error
}

func ParsePatchApiSessionsSessionResponse

func ParsePatchApiSessionsSessionResponse(rsp *http.Response) (*PatchApiSessionsSessionResponse, error)

ParsePatchApiSessionsSessionResponse parses an HTTP response from a PatchApiSessionsSessionWithResponse call

func (PatchApiSessionsSessionResponse) Status

Status returns HTTPResponse.Status

func (PatchApiSessionsSessionResponse) StatusCode

func (r PatchApiSessionsSessionResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiKernelsJSONBody

type PostApiKernelsJSONBody struct {
	// Env A dictionary of environment variables and values to include in the
	// kernel process - subject to filtering.
	Env *map[string]string `json:"env,omitempty"`

	// Name Kernel spec name (defaults to default kernel spec for server)
	Name *string `json:"name,omitempty"`
}

PostApiKernelsJSONBody defines parameters for PostApiKernels.

type PostApiKernelsJSONRequestBody

type PostApiKernelsJSONRequestBody PostApiKernelsJSONBody

PostApiKernelsJSONRequestBody defines body for PostApiKernels for application/json ContentType.

type PostApiKernelsResponse

type PostApiKernelsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Kernel
	JSON403      *Error
}

func ParsePostApiKernelsResponse

func ParsePostApiKernelsResponse(rsp *http.Response) (*PostApiKernelsResponse, error)

ParsePostApiKernelsResponse parses an HTTP response from a PostApiKernelsWithResponse call

func (PostApiKernelsResponse) Status

func (r PostApiKernelsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiKernelsResponse) StatusCode

func (r PostApiKernelsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostApiSessionsJSONRequestBody

type PostApiSessionsJSONRequestBody = Session

PostApiSessionsJSONRequestBody defines body for PostApiSessions for application/json ContentType.

type PostApiSessionsResponse

type PostApiSessionsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *Session
	JSON501      *Error
}

func ParsePostApiSessionsResponse

func ParsePostApiSessionsResponse(rsp *http.Response) (*PostApiSessionsResponse, error)

ParsePostApiSessionsResponse parses an HTTP response from a PostApiSessionsWithResponse call

func (PostApiSessionsResponse) Status

func (r PostApiSessionsResponse) Status() string

Status returns HTTPResponse.Status

func (PostApiSessionsResponse) StatusCode

func (r PostApiSessionsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type PostKernelsKernelIdInterruptResponse

type PostKernelsKernelIdInterruptResponse struct {
	Body         []byte
	HTTPResponse *http.Response
}

func ParsePostKernelsKernelIdInterruptResponse

func ParsePostKernelsKernelIdInterruptResponse(rsp *http.Response) (*PostKernelsKernelIdInterruptResponse, error)

ParsePostKernelsKernelIdInterruptResponse parses an HTTP response from a PostKernelsKernelIdInterruptWithResponse call

func (PostKernelsKernelIdInterruptResponse) Status

Status returns HTTPResponse.Status

func (PostKernelsKernelIdInterruptResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type PostKernelsKernelIdRestartResponse

type PostKernelsKernelIdRestartResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *Kernel
}

func ParsePostKernelsKernelIdRestartResponse

func ParsePostKernelsKernelIdRestartResponse(rsp *http.Response) (*PostKernelsKernelIdRestartResponse, error)

ParsePostKernelsKernelIdRestartResponse parses an HTTP response from a PostKernelsKernelIdRestartWithResponse call

func (PostKernelsKernelIdRestartResponse) Status

Status returns HTTPResponse.Status

func (PostKernelsKernelIdRestartResponse) StatusCode

func (r PostKernelsKernelIdRestartResponse) 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 Session

type Session struct {
	Id *openapi_types.UUID `json:"id,omitempty"`

	// Kernel Kernel information
	Kernel *Kernel `json:"kernel,omitempty"`

	// Name name of the session
	Name *string `json:"name,omitempty"`

	// Path path to the session
	Path *string `json:"path,omitempty"`

	// Type session type
	Type *string `json:"type,omitempty"`
}

Session A session

Jump to

Keyboard shortcuts

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