api

package
v0.0.0-...-9e5a2db Latest Latest
Warning

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

Go to latest
Published: Jan 14, 2026 License: Apache-2.0 Imports: 15 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.

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.

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.

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 (
	ApiKeyAuthScopes = "ApiKeyAuth.Scopes"
)

Variables

This section is empty.

Functions

func GetSwagger

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func NewHealthCheckMachineRequest

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

NewHealthCheckMachineRequest generates requests for HealthCheckMachine

func NewHealthCheckRequest

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

NewHealthCheckRequest generates requests for HealthCheck

func NewHealthCheckTrafficRequest

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

NewHealthCheckTrafficRequest generates requests for HealthCheckTraffic

func NewV1InfoRequest

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

NewV1InfoRequest generates requests for V1Info

func NewV1SandboxLogsRequest

func NewV1SandboxLogsRequest(server string, sandboxID string, params *V1SandboxLogsParams) (*http.Request, error)

NewV1SandboxLogsRequest generates requests for V1SandboxLogs

func NewV1SandboxMetricsRequest

func NewV1SandboxMetricsRequest(server string, sandboxID string, params *V1SandboxMetricsParams) (*http.Request, error)

NewV1SandboxMetricsRequest generates requests for V1SandboxMetrics

func NewV1SandboxesMetricsRequest

func NewV1SandboxesMetricsRequest(server string, params *V1SandboxesMetricsParams) (*http.Request, error)

NewV1SandboxesMetricsRequest generates requests for V1SandboxesMetrics

func NewV1ServiceDiscoveryGetOrchestratorsRequest

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

NewV1ServiceDiscoveryGetOrchestratorsRequest generates requests for V1ServiceDiscoveryGetOrchestrators

func NewV1ServiceDiscoveryNodeDrainRequest

func NewV1ServiceDiscoveryNodeDrainRequest(server string, body V1ServiceDiscoveryNodeDrainJSONRequestBody) (*http.Request, error)

NewV1ServiceDiscoveryNodeDrainRequest calls the generic V1ServiceDiscoveryNodeDrain builder with application/json body

func NewV1ServiceDiscoveryNodeDrainRequestWithBody

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

NewV1ServiceDiscoveryNodeDrainRequestWithBody generates requests for V1ServiceDiscoveryNodeDrain with any type of body

func NewV1ServiceDiscoveryNodeKillRequest

func NewV1ServiceDiscoveryNodeKillRequest(server string, body V1ServiceDiscoveryNodeKillJSONRequestBody) (*http.Request, error)

NewV1ServiceDiscoveryNodeKillRequest calls the generic V1ServiceDiscoveryNodeKill builder with application/json body

func NewV1ServiceDiscoveryNodeKillRequestWithBody

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

NewV1ServiceDiscoveryNodeKillRequestWithBody generates requests for V1ServiceDiscoveryNodeKill with any type of body

func NewV1ServiceDiscoveryNodesRequest

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

NewV1ServiceDiscoveryNodesRequest generates requests for V1ServiceDiscoveryNodes

func NewV1TemplateBuildLogsRequest

func NewV1TemplateBuildLogsRequest(server string, buildID string, params *V1TemplateBuildLogsParams) (*http.Request, error)

NewV1TemplateBuildLogsRequest generates requests for V1TemplateBuildLogs

func PathToRawSpec

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

func RegisterHandlers

func RegisterHandlers(router gin.IRouter, si ServerInterface)

RegisterHandlers creates http.Handler with routing matching OpenAPI spec.

func RegisterHandlersWithOptions

func RegisterHandlersWithOptions(router gin.IRouter, si ServerInterface, options GinServerOptions)

RegisterHandlersWithOptions creates http.Handler with additional options

Types

type BuildLogEntry

type BuildLogEntry struct {
	Fields map[string]string `json:"fields"`

	// Level State of the sandbox
	Level LogLevel `json:"level"`

	// Message Log message content
	Message string `json:"message"`

	// Timestamp Timestamp of the log entry
	Timestamp time.Time `json:"timestamp"`
}

BuildLogEntry defines model for BuildLogEntry.

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

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

func (*Client) HealthCheckMachine

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

func (*Client) HealthCheckTraffic

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

func (*Client) V1Info

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

func (*Client) V1SandboxLogs

func (c *Client) V1SandboxLogs(ctx context.Context, sandboxID string, params *V1SandboxLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) V1SandboxMetrics

func (c *Client) V1SandboxMetrics(ctx context.Context, sandboxID string, params *V1SandboxMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) V1SandboxesMetrics

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

func (*Client) V1ServiceDiscoveryGetOrchestrators

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

func (*Client) V1ServiceDiscoveryNodeDrain

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

func (*Client) V1ServiceDiscoveryNodeDrainWithBody

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

func (*Client) V1ServiceDiscoveryNodeKill

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

func (*Client) V1ServiceDiscoveryNodeKillWithBody

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

func (*Client) V1ServiceDiscoveryNodes

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

func (*Client) V1TemplateBuildLogs

func (c *Client) V1TemplateBuildLogs(ctx context.Context, buildID string, params *V1TemplateBuildLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

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

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

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

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

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

	// V1SandboxLogs request
	V1SandboxLogs(ctx context.Context, sandboxID string, params *V1SandboxLogsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// V1SandboxMetrics request
	V1SandboxMetrics(ctx context.Context, sandboxID string, params *V1SandboxMetricsParams, reqEditors ...RequestEditorFn) (*http.Response, error)

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

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

	V1ServiceDiscoveryNodeDrain(ctx context.Context, body V1ServiceDiscoveryNodeDrainJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	V1ServiceDiscoveryNodeKill(ctx context.Context, body V1ServiceDiscoveryNodeKillJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

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

	// V1TemplateBuildLogs request
	V1TemplateBuildLogs(ctx context.Context, buildID string, params *V1TemplateBuildLogsParams, 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) HealthCheckMachineWithResponse

func (c *ClientWithResponses) HealthCheckMachineWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckMachineResponse, error)

HealthCheckMachineWithResponse request returning *HealthCheckMachineResponse

func (*ClientWithResponses) HealthCheckTrafficWithResponse

func (c *ClientWithResponses) HealthCheckTrafficWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckTrafficResponse, error)

HealthCheckTrafficWithResponse request returning *HealthCheckTrafficResponse

func (*ClientWithResponses) HealthCheckWithResponse

func (c *ClientWithResponses) HealthCheckWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckResponse, error)

HealthCheckWithResponse request returning *HealthCheckResponse

func (*ClientWithResponses) V1InfoWithResponse

func (c *ClientWithResponses) V1InfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1InfoResponse, error)

V1InfoWithResponse request returning *V1InfoResponse

func (*ClientWithResponses) V1SandboxLogsWithResponse

func (c *ClientWithResponses) V1SandboxLogsWithResponse(ctx context.Context, sandboxID string, params *V1SandboxLogsParams, reqEditors ...RequestEditorFn) (*V1SandboxLogsResponse, error)

V1SandboxLogsWithResponse request returning *V1SandboxLogsResponse

func (*ClientWithResponses) V1SandboxMetricsWithResponse

func (c *ClientWithResponses) V1SandboxMetricsWithResponse(ctx context.Context, sandboxID string, params *V1SandboxMetricsParams, reqEditors ...RequestEditorFn) (*V1SandboxMetricsResponse, error)

V1SandboxMetricsWithResponse request returning *V1SandboxMetricsResponse

func (*ClientWithResponses) V1SandboxesMetricsWithResponse

func (c *ClientWithResponses) V1SandboxesMetricsWithResponse(ctx context.Context, params *V1SandboxesMetricsParams, reqEditors ...RequestEditorFn) (*V1SandboxesMetricsResponse, error)

V1SandboxesMetricsWithResponse request returning *V1SandboxesMetricsResponse

func (*ClientWithResponses) V1ServiceDiscoveryGetOrchestratorsWithResponse

func (c *ClientWithResponses) V1ServiceDiscoveryGetOrchestratorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryGetOrchestratorsResponse, error)

V1ServiceDiscoveryGetOrchestratorsWithResponse request returning *V1ServiceDiscoveryGetOrchestratorsResponse

func (*ClientWithResponses) V1ServiceDiscoveryNodeDrainWithBodyWithResponse

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

V1ServiceDiscoveryNodeDrainWithBodyWithResponse request with arbitrary body returning *V1ServiceDiscoveryNodeDrainResponse

func (*ClientWithResponses) V1ServiceDiscoveryNodeDrainWithResponse

func (c *ClientWithResponses) V1ServiceDiscoveryNodeDrainWithResponse(ctx context.Context, body V1ServiceDiscoveryNodeDrainJSONRequestBody, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodeDrainResponse, error)

func (*ClientWithResponses) V1ServiceDiscoveryNodeKillWithBodyWithResponse

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

V1ServiceDiscoveryNodeKillWithBodyWithResponse request with arbitrary body returning *V1ServiceDiscoveryNodeKillResponse

func (*ClientWithResponses) V1ServiceDiscoveryNodeKillWithResponse

func (c *ClientWithResponses) V1ServiceDiscoveryNodeKillWithResponse(ctx context.Context, body V1ServiceDiscoveryNodeKillJSONRequestBody, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodeKillResponse, error)

func (*ClientWithResponses) V1ServiceDiscoveryNodesWithResponse

func (c *ClientWithResponses) V1ServiceDiscoveryNodesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodesResponse, error)

V1ServiceDiscoveryNodesWithResponse request returning *V1ServiceDiscoveryNodesResponse

func (*ClientWithResponses) V1TemplateBuildLogsWithResponse

func (c *ClientWithResponses) V1TemplateBuildLogsWithResponse(ctx context.Context, buildID string, params *V1TemplateBuildLogsParams, reqEditors ...RequestEditorFn) (*V1TemplateBuildLogsResponse, error)

V1TemplateBuildLogsWithResponse request returning *V1TemplateBuildLogsResponse

type ClientWithResponsesInterface

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

	// HealthCheckMachineWithResponse request
	HealthCheckMachineWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckMachineResponse, error)

	// HealthCheckTrafficWithResponse request
	HealthCheckTrafficWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*HealthCheckTrafficResponse, error)

	// V1InfoWithResponse request
	V1InfoWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1InfoResponse, error)

	// V1SandboxesMetricsWithResponse request
	V1SandboxesMetricsWithResponse(ctx context.Context, params *V1SandboxesMetricsParams, reqEditors ...RequestEditorFn) (*V1SandboxesMetricsResponse, error)

	// V1SandboxLogsWithResponse request
	V1SandboxLogsWithResponse(ctx context.Context, sandboxID string, params *V1SandboxLogsParams, reqEditors ...RequestEditorFn) (*V1SandboxLogsResponse, error)

	// V1SandboxMetricsWithResponse request
	V1SandboxMetricsWithResponse(ctx context.Context, sandboxID string, params *V1SandboxMetricsParams, reqEditors ...RequestEditorFn) (*V1SandboxMetricsResponse, error)

	// V1ServiceDiscoveryNodesWithResponse request
	V1ServiceDiscoveryNodesWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodesResponse, error)

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

	V1ServiceDiscoveryNodeDrainWithResponse(ctx context.Context, body V1ServiceDiscoveryNodeDrainJSONRequestBody, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodeDrainResponse, error)

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

	V1ServiceDiscoveryNodeKillWithResponse(ctx context.Context, body V1ServiceDiscoveryNodeKillJSONRequestBody, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryNodeKillResponse, error)

	// V1ServiceDiscoveryGetOrchestratorsWithResponse request
	V1ServiceDiscoveryGetOrchestratorsWithResponse(ctx context.Context, reqEditors ...RequestEditorFn) (*V1ServiceDiscoveryGetOrchestratorsResponse, error)

	// V1TemplateBuildLogsWithResponse request
	V1TemplateBuildLogsWithResponse(ctx context.Context, buildID string, params *V1TemplateBuildLogsParams, reqEditors ...RequestEditorFn) (*V1TemplateBuildLogsResponse, error)
}

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

type ClusterNode

type ClusterNode struct {
	// NodeID Node ID
	NodeID string `json:"nodeID"`

	// ServiceHost Node private host address and service port
	ServiceHost string `json:"serviceHost"`

	// ServiceInstanceID Service instance ID
	ServiceInstanceID string `json:"serviceInstanceID"`

	// ServiceStartedAt Time when the node was registered
	ServiceStartedAt time.Time `json:"serviceStartedAt"`

	// ServiceStatus State of the cluster node
	ServiceStatus ClusterNodeStatus `json:"serviceStatus"`

	// ServiceType Cluster node type
	ServiceType ClusterNodeType `json:"serviceType"`

	// ServiceVersion Version of the service
	ServiceVersion string `json:"serviceVersion"`

	// ServiceVersionCommit Source code version of the service
	ServiceVersionCommit string `json:"serviceVersionCommit"`
}

ClusterNode defines model for ClusterNode.

type ClusterNodeInfo

type ClusterNodeInfo struct {
	// NodeID Node ID
	NodeID string `json:"nodeID"`

	// ServiceInstanceID Service ID
	ServiceInstanceID string `json:"serviceInstanceID"`

	// ServiceStartup Time when the node started
	ServiceStartup time.Time `json:"serviceStartup"`

	// ServiceStatus State of the cluster node
	ServiceStatus ClusterNodeStatus `json:"serviceStatus"`

	// ServiceVersion Version of the service
	ServiceVersion string `json:"serviceVersion"`

	// ServiceVersionCommit Version of the service
	ServiceVersionCommit string `json:"serviceVersionCommit"`
}

ClusterNodeInfo defines model for ClusterNodeInfo.

type ClusterNodeStatus

type ClusterNodeStatus string

ClusterNodeStatus State of the cluster node

const (
	Draining  ClusterNodeStatus = "draining"
	Healthy   ClusterNodeStatus = "healthy"
	Unhealthy ClusterNodeStatus = "unhealthy"
)

Defines values for ClusterNodeStatus.

type ClusterNodeType

type ClusterNodeType string

ClusterNodeType Cluster node type

const (
	ClusterNodeTypeOrchestrator ClusterNodeType = "orchestrator"
)

Defines values for ClusterNodeType.

type ClusterOrchestratorNode

type ClusterOrchestratorNode struct {
	// NodeID Node ID
	NodeID string                    `json:"nodeID"`
	Roles  []ClusterOrchestratorRole `json:"roles"`

	// ServiceHost Node private host address and service port
	ServiceHost string `json:"serviceHost"`

	// ServiceInstanceID Service instance ID
	ServiceInstanceID string `json:"serviceInstanceID"`

	// ServiceStartedAt Time when the node was registered
	ServiceStartedAt time.Time `json:"serviceStartedAt"`

	// ServiceStatus State of the cluster node
	ServiceStatus ClusterNodeStatus `json:"serviceStatus"`

	// ServiceVersion Service Version
	ServiceVersion string `json:"serviceVersion"`

	// ServiceVersionCommit Service Version
	ServiceVersionCommit string `json:"serviceVersionCommit"`
}

ClusterOrchestratorNode defines model for ClusterOrchestratorNode.

type ClusterOrchestratorRole

type ClusterOrchestratorRole string

ClusterOrchestratorRole Capability of the orchestrator

const (
	ClusterOrchestratorRoleOrchestrator    ClusterOrchestratorRole = "orchestrator"
	ClusterOrchestratorRoleTemplateBuilder ClusterOrchestratorRole = "template-builder"
)

Defines values for ClusterOrchestratorRole.

type Error

type Error struct {
	// Code Error code
	Code int32 `json:"code"`

	// Message Error
	Message string `json:"message"`
}

Error defines model for Error.

type GinServerOptions

type GinServerOptions struct {
	BaseURL      string
	Middlewares  []MiddlewareFunc
	ErrorHandler func(*gin.Context, error, int)
}

GinServerOptions provides options for the Gin server.

type HealthCheckMachineResponse

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

func ParseHealthCheckMachineResponse

func ParseHealthCheckMachineResponse(rsp *http.Response) (*HealthCheckMachineResponse, error)

ParseHealthCheckMachineResponse parses an HTTP response from a HealthCheckMachineWithResponse call

func (HealthCheckMachineResponse) Status

Status returns HTTPResponse.Status

func (HealthCheckMachineResponse) StatusCode

func (r HealthCheckMachineResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthCheckResponse

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

func ParseHealthCheckResponse

func ParseHealthCheckResponse(rsp *http.Response) (*HealthCheckResponse, error)

ParseHealthCheckResponse parses an HTTP response from a HealthCheckWithResponse call

func (HealthCheckResponse) Status

func (r HealthCheckResponse) Status() string

Status returns HTTPResponse.Status

func (HealthCheckResponse) StatusCode

func (r HealthCheckResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type HealthCheckTrafficResponse

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

func ParseHealthCheckTrafficResponse

func ParseHealthCheckTrafficResponse(rsp *http.Response) (*HealthCheckTrafficResponse, error)

ParseHealthCheckTrafficResponse parses an HTTP response from a HealthCheckTrafficWithResponse call

func (HealthCheckTrafficResponse) Status

Status returns HTTPResponse.Status

func (HealthCheckTrafficResponse) StatusCode

func (r HealthCheckTrafficResponse) 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 LogLevel

type LogLevel string

LogLevel State of the sandbox

const (
	LogLevelDebug LogLevel = "debug"
	LogLevelError LogLevel = "error"
	LogLevelInfo  LogLevel = "info"
	LogLevelWarn  LogLevel = "warn"
)

Defines values for LogLevel.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type N400

type N400 = Error

N400 defines model for 400.

type N401

type N401 = Error

N401 defines model for 401.

type N404

type N404 = Error

N404 defines model for 404.

type N500

type N500 = Error

N500 defines model for 500.

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type SandboxLog

type SandboxLog struct {
	// Line Log line content
	Line string `json:"line"`

	// Timestamp Timestamp of the log entry
	Timestamp time.Time `json:"timestamp"`
}

SandboxLog Log entry with timestamp and line

type SandboxLogEntry

type SandboxLogEntry struct {
	Fields map[string]string `json:"fields"`

	// Level State of the sandbox
	Level LogLevel `json:"level"`

	// Message Log message content
	Message string `json:"message"`

	// Timestamp Timestamp of the log entry
	Timestamp time.Time `json:"timestamp"`
}

SandboxLogEntry defines model for SandboxLogEntry.

type SandboxLogsResponse

type SandboxLogsResponse struct {
	// LogEntries Structured logs of the sandbox
	LogEntries []SandboxLogEntry `json:"logEntries"`

	// Logs Sandbox logs
	Logs []SandboxLog `json:"logs"`
}

SandboxLogsResponse defines model for SandboxLogsResponse.

type SandboxMetric

type SandboxMetric struct {
	// CpuCount Number of CPUs
	CpuCount int32 `json:"cpu_count"`

	// CpuUsedPct CPU usage percentage
	CpuUsedPct float32 `json:"cpu_used_pct"`

	// DiskTotal Total disk space in bytes
	DiskTotal int64 `json:"disk_total"`

	// DiskUsed Used disk space in bytes
	DiskUsed int64 `json:"disk_used"`

	// MemTotal Total memory in bytes
	MemTotal int64 `json:"mem_total"`

	// MemUsed Used memory in bytes
	MemUsed int64 `json:"mem_used"`

	// Timestamp Timestamp of the metric
	Timestamp time.Time `json:"timestamp"`

	// TimestampUnix Unix timestamp in seconds
	TimestampUnix int64 `json:"timestamp_unix"`
}

SandboxMetric defines model for SandboxMetric.

type SandboxesWithMetrics

type SandboxesWithMetrics struct {
	// Sandboxes Map of sandbox IDs to their latest metrics
	Sandboxes map[string]SandboxMetric `json:"sandboxes"`
}

SandboxesWithMetrics defines model for SandboxesWithMetrics.

type ServerInterface

type ServerInterface interface {

	// (GET /health)
	HealthCheck(c *gin.Context)

	// (GET /health/machine)
	HealthCheckMachine(c *gin.Context)

	// (GET /health/traffic)
	HealthCheckTraffic(c *gin.Context)

	// (GET /v1/info)
	V1Info(c *gin.Context)
	// Get latest metrics for multiple sandboxes
	// (GET /v1/sandboxes/metrics)
	V1SandboxesMetrics(c *gin.Context, params V1SandboxesMetricsParams)
	// List structured sandbox logs
	// (GET /v1/sandboxes/{sandboxID}/logs)
	V1SandboxLogs(c *gin.Context, sandboxID string, params V1SandboxLogsParams)
	// Get time-series metrics for a sandbox
	// (GET /v1/sandboxes/{sandboxID}/metrics)
	V1SandboxMetrics(c *gin.Context, sandboxID string, params V1SandboxMetricsParams)

	// (GET /v1/service-discovery/nodes)
	V1ServiceDiscoveryNodes(c *gin.Context)

	// (POST /v1/service-discovery/nodes/drain)
	V1ServiceDiscoveryNodeDrain(c *gin.Context)

	// (POST /v1/service-discovery/nodes/kill)
	V1ServiceDiscoveryNodeKill(c *gin.Context)
	// Get the orchestrators
	// (GET /v1/service-discovery/nodes/orchestrators)
	V1ServiceDiscoveryGetOrchestrators(c *gin.Context)
	// Template build logs
	// (GET /v1/templates/builds/{buildID}/logs)
	V1TemplateBuildLogs(c *gin.Context, buildID string, params V1TemplateBuildLogsParams)
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper

type ServerInterfaceWrapper struct {
	Handler            ServerInterface
	HandlerMiddlewares []MiddlewareFunc
	ErrorHandler       func(*gin.Context, error, int)
}

ServerInterfaceWrapper converts contexts to parameters.

func (*ServerInterfaceWrapper) HealthCheck

func (siw *ServerInterfaceWrapper) HealthCheck(c *gin.Context)

HealthCheck operation middleware

func (*ServerInterfaceWrapper) HealthCheckMachine

func (siw *ServerInterfaceWrapper) HealthCheckMachine(c *gin.Context)

HealthCheckMachine operation middleware

func (*ServerInterfaceWrapper) HealthCheckTraffic

func (siw *ServerInterfaceWrapper) HealthCheckTraffic(c *gin.Context)

HealthCheckTraffic operation middleware

func (*ServerInterfaceWrapper) V1Info

func (siw *ServerInterfaceWrapper) V1Info(c *gin.Context)

V1Info operation middleware

func (*ServerInterfaceWrapper) V1SandboxLogs

func (siw *ServerInterfaceWrapper) V1SandboxLogs(c *gin.Context)

V1SandboxLogs operation middleware

func (*ServerInterfaceWrapper) V1SandboxMetrics

func (siw *ServerInterfaceWrapper) V1SandboxMetrics(c *gin.Context)

V1SandboxMetrics operation middleware

func (*ServerInterfaceWrapper) V1SandboxesMetrics

func (siw *ServerInterfaceWrapper) V1SandboxesMetrics(c *gin.Context)

V1SandboxesMetrics operation middleware

func (*ServerInterfaceWrapper) V1ServiceDiscoveryGetOrchestrators

func (siw *ServerInterfaceWrapper) V1ServiceDiscoveryGetOrchestrators(c *gin.Context)

V1ServiceDiscoveryGetOrchestrators operation middleware

func (*ServerInterfaceWrapper) V1ServiceDiscoveryNodeDrain

func (siw *ServerInterfaceWrapper) V1ServiceDiscoveryNodeDrain(c *gin.Context)

V1ServiceDiscoveryNodeDrain operation middleware

func (*ServerInterfaceWrapper) V1ServiceDiscoveryNodeKill

func (siw *ServerInterfaceWrapper) V1ServiceDiscoveryNodeKill(c *gin.Context)

V1ServiceDiscoveryNodeKill operation middleware

func (*ServerInterfaceWrapper) V1ServiceDiscoveryNodes

func (siw *ServerInterfaceWrapper) V1ServiceDiscoveryNodes(c *gin.Context)

V1ServiceDiscoveryNodes operation middleware

func (*ServerInterfaceWrapper) V1TemplateBuildLogs

func (siw *ServerInterfaceWrapper) V1TemplateBuildLogs(c *gin.Context)

V1TemplateBuildLogs operation middleware

type ServiceDiscoveryNodeStatusRequest

type ServiceDiscoveryNodeStatusRequest struct {
	// ServiceInstanceID Service instance ID that should be handled by the request
	ServiceInstanceID string `json:"serviceInstanceID"`

	// ServiceType Cluster node type
	ServiceType ClusterNodeType `json:"serviceType"`
}

ServiceDiscoveryNodeStatusRequest defines model for ServiceDiscoveryNodeStatusRequest.

type TemplateBuildLogsResponse

type TemplateBuildLogsResponse struct {
	// LogEntries Build logs structured
	LogEntries []BuildLogEntry `json:"logEntries"`
}

TemplateBuildLogsResponse defines model for TemplateBuildLogsResponse.

type V1InfoResponse

type V1InfoResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *ClusterNodeInfo
	JSON401      *N401
	JSON500      *N500
}

func ParseV1InfoResponse

func ParseV1InfoResponse(rsp *http.Response) (*V1InfoResponse, error)

ParseV1InfoResponse parses an HTTP response from a V1InfoWithResponse call

func (V1InfoResponse) Status

func (r V1InfoResponse) Status() string

Status returns HTTPResponse.Status

func (V1InfoResponse) StatusCode

func (r V1InfoResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1SandboxLogsParams

type V1SandboxLogsParams struct {
	TeamID string `form:"teamID" json:"teamID"`

	// Start Starting timestamp of the logs that should be returned in milliseconds
	Start *int64 `form:"start,omitempty" json:"start,omitempty"`

	// Limit Maximum number of logs that should be returned
	Limit *int32 `form:"limit,omitempty" json:"limit,omitempty"`
}

V1SandboxLogsParams defines parameters for V1SandboxLogs.

type V1SandboxLogsResponse

type V1SandboxLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SandboxLogsResponse
	JSON400      *N400
	JSON401      *N401
	JSON500      *N500
}

func ParseV1SandboxLogsResponse

func ParseV1SandboxLogsResponse(rsp *http.Response) (*V1SandboxLogsResponse, error)

ParseV1SandboxLogsResponse parses an HTTP response from a V1SandboxLogsWithResponse call

func (V1SandboxLogsResponse) Status

func (r V1SandboxLogsResponse) Status() string

Status returns HTTPResponse.Status

func (V1SandboxLogsResponse) StatusCode

func (r V1SandboxLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1SandboxMetricsParams

type V1SandboxMetricsParams struct {
	// TeamID Team ID that owns the sandbox
	TeamID string `form:"teamID" json:"teamID"`

	// Start Start time in Unix seconds
	Start *int64 `form:"start,omitempty" json:"start,omitempty"`

	// End End time in Unix seconds
	End *int64 `form:"end,omitempty" json:"end,omitempty"`
}

V1SandboxMetricsParams defines parameters for V1SandboxMetrics.

type V1SandboxMetricsResponse

type V1SandboxMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]SandboxMetric
	JSON400      *N400
	JSON401      *N401
	JSON500      *N500
}

func ParseV1SandboxMetricsResponse

func ParseV1SandboxMetricsResponse(rsp *http.Response) (*V1SandboxMetricsResponse, error)

ParseV1SandboxMetricsResponse parses an HTTP response from a V1SandboxMetricsWithResponse call

func (V1SandboxMetricsResponse) Status

func (r V1SandboxMetricsResponse) Status() string

Status returns HTTPResponse.Status

func (V1SandboxMetricsResponse) StatusCode

func (r V1SandboxMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1SandboxesMetricsParams

type V1SandboxesMetricsParams struct {
	// TeamID Team ID that owns the sandboxes
	TeamID string `form:"teamID" json:"teamID"`

	// SandboxIds List of sandbox IDs (max 100)
	SandboxIds []string `form:"sandbox_ids" json:"sandbox_ids"`
}

V1SandboxesMetricsParams defines parameters for V1SandboxesMetrics.

type V1SandboxesMetricsResponse

type V1SandboxesMetricsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SandboxesWithMetrics
	JSON400      *N400
	JSON401      *N401
	JSON500      *N500
}

func ParseV1SandboxesMetricsResponse

func ParseV1SandboxesMetricsResponse(rsp *http.Response) (*V1SandboxesMetricsResponse, error)

ParseV1SandboxesMetricsResponse parses an HTTP response from a V1SandboxesMetricsWithResponse call

func (V1SandboxesMetricsResponse) Status

Status returns HTTPResponse.Status

func (V1SandboxesMetricsResponse) StatusCode

func (r V1SandboxesMetricsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1ServiceDiscoveryGetOrchestratorsResponse

type V1ServiceDiscoveryGetOrchestratorsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ClusterOrchestratorNode
	JSON401      *N401
	JSON500      *N500
}

func ParseV1ServiceDiscoveryGetOrchestratorsResponse

func ParseV1ServiceDiscoveryGetOrchestratorsResponse(rsp *http.Response) (*V1ServiceDiscoveryGetOrchestratorsResponse, error)

ParseV1ServiceDiscoveryGetOrchestratorsResponse parses an HTTP response from a V1ServiceDiscoveryGetOrchestratorsWithResponse call

func (V1ServiceDiscoveryGetOrchestratorsResponse) Status

Status returns HTTPResponse.Status

func (V1ServiceDiscoveryGetOrchestratorsResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type V1ServiceDiscoveryNodeDrainJSONRequestBody

type V1ServiceDiscoveryNodeDrainJSONRequestBody = ServiceDiscoveryNodeStatusRequest

V1ServiceDiscoveryNodeDrainJSONRequestBody defines body for V1ServiceDiscoveryNodeDrain for application/json ContentType.

type V1ServiceDiscoveryNodeDrainResponse

type V1ServiceDiscoveryNodeDrainResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
	JSON401      *N401
	JSON404      *N404
	JSON500      *N500
}

func ParseV1ServiceDiscoveryNodeDrainResponse

func ParseV1ServiceDiscoveryNodeDrainResponse(rsp *http.Response) (*V1ServiceDiscoveryNodeDrainResponse, error)

ParseV1ServiceDiscoveryNodeDrainResponse parses an HTTP response from a V1ServiceDiscoveryNodeDrainWithResponse call

func (V1ServiceDiscoveryNodeDrainResponse) Status

Status returns HTTPResponse.Status

func (V1ServiceDiscoveryNodeDrainResponse) StatusCode

StatusCode returns HTTPResponse.StatusCode

type V1ServiceDiscoveryNodeKillJSONRequestBody

type V1ServiceDiscoveryNodeKillJSONRequestBody = ServiceDiscoveryNodeStatusRequest

V1ServiceDiscoveryNodeKillJSONRequestBody defines body for V1ServiceDiscoveryNodeKill for application/json ContentType.

type V1ServiceDiscoveryNodeKillResponse

type V1ServiceDiscoveryNodeKillResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON400      *N400
	JSON401      *N401
	JSON404      *N404
	JSON500      *N500
}

func ParseV1ServiceDiscoveryNodeKillResponse

func ParseV1ServiceDiscoveryNodeKillResponse(rsp *http.Response) (*V1ServiceDiscoveryNodeKillResponse, error)

ParseV1ServiceDiscoveryNodeKillResponse parses an HTTP response from a V1ServiceDiscoveryNodeKillWithResponse call

func (V1ServiceDiscoveryNodeKillResponse) Status

Status returns HTTPResponse.Status

func (V1ServiceDiscoveryNodeKillResponse) StatusCode

func (r V1ServiceDiscoveryNodeKillResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1ServiceDiscoveryNodesResponse

type V1ServiceDiscoveryNodesResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *[]ClusterNode
	JSON401      *N401
	JSON500      *N500
}

func ParseV1ServiceDiscoveryNodesResponse

func ParseV1ServiceDiscoveryNodesResponse(rsp *http.Response) (*V1ServiceDiscoveryNodesResponse, error)

ParseV1ServiceDiscoveryNodesResponse parses an HTTP response from a V1ServiceDiscoveryNodesWithResponse call

func (V1ServiceDiscoveryNodesResponse) Status

Status returns HTTPResponse.Status

func (V1ServiceDiscoveryNodesResponse) StatusCode

func (r V1ServiceDiscoveryNodesResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type V1TemplateBuildLogsParams

type V1TemplateBuildLogsParams struct {
	OrchestratorID *string `form:"orchestratorID,omitempty" json:"orchestratorID,omitempty"`
	TemplateID     string  `form:"templateID" json:"templateID"`

	// Offset Index of the starting build log that should be returned with the template
	Offset *int32 `form:"offset,omitempty" json:"offset,omitempty"`

	// Start Starting timestamp of the logs that should be returned in milliseconds
	Start *int64 `form:"start,omitempty" json:"start,omitempty"`

	// End Ending timestamp of the logs that should be returned in milliseconds
	End *int64 `form:"end,omitempty" json:"end,omitempty"`

	// Limit Maximum number of logs that should be returned
	Limit     *int32                              `form:"limit,omitempty" json:"limit,omitempty"`
	Direction *V1TemplateBuildLogsParamsDirection `form:"direction,omitempty" json:"direction,omitempty"`
	Level     *LogLevel                           `form:"level,omitempty" json:"level,omitempty"`
}

V1TemplateBuildLogsParams defines parameters for V1TemplateBuildLogs.

type V1TemplateBuildLogsParamsDirection

type V1TemplateBuildLogsParamsDirection string

V1TemplateBuildLogsParamsDirection defines parameters for V1TemplateBuildLogs.

const (
	Backward V1TemplateBuildLogsParamsDirection = "backward"
	Forward  V1TemplateBuildLogsParamsDirection = "forward"
)

Defines values for V1TemplateBuildLogsParamsDirection.

type V1TemplateBuildLogsResponse

type V1TemplateBuildLogsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *TemplateBuildLogsResponse
	JSON400      *N400
	JSON401      *N401
	JSON500      *N500
}

func ParseV1TemplateBuildLogsResponse

func ParseV1TemplateBuildLogsResponse(rsp *http.Response) (*V1TemplateBuildLogsResponse, error)

ParseV1TemplateBuildLogsResponse parses an HTTP response from a V1TemplateBuildLogsWithResponse call

func (V1TemplateBuildLogsResponse) Status

Status returns HTTPResponse.Status

func (V1TemplateBuildLogsResponse) StatusCode

func (r V1TemplateBuildLogsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

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