generated

package
v1.9.0 Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package generated 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 (
	CookieAuthScopes = "cookieAuth.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 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 ApiLimits

type ApiLimits struct {
	DefaultPageSize     int `json:"defaultPageSize"`
	MaximumLogLines     int `json:"maximumLogLines"`
	MaximumMetricPoints int `json:"maximumMetricPoints"`
	MaximumPageSize     int `json:"maximumPageSize"`
}

ApiLimits defines model for ApiLimits.

type Capabilities

type Capabilities struct {
	ApiVersion string    `json:"apiVersion"`
	Limits     ApiLimits `json:"limits"`
	Operations []string  `json:"operations"`
}

Capabilities defines model for Capabilities.

type Condition

type Condition struct {
	LastTransitionTime time.Time       `json:"lastTransitionTime"`
	Message            *string         `json:"message,omitempty"`
	ObservedGeneration int64           `json:"observedGeneration"`
	Reason             string          `json:"reason"`
	Status             ConditionStatus `json:"status"`
	Type               string          `json:"type"`
}

Condition defines model for Condition.

type ConditionStatus

type ConditionStatus string

ConditionStatus defines model for Condition.Status.

const (
	ConditionStatusFalse   ConditionStatus = "False"
	ConditionStatusTrue    ConditionStatus = "True"
	ConditionStatusUnknown ConditionStatus = "Unknown"
)

Defines values for ConditionStatus.

type Forbidden

type Forbidden = Problem

Forbidden defines model for Forbidden.

type GetMonoVertexStatusParams

type GetMonoVertexStatusParams struct {
	// IfNoneMatch ETag from an earlier response
	IfNoneMatch *IfNoneMatch `json:"If-None-Match,omitempty"`
}

GetMonoVertexStatusParams defines parameters for GetMonoVertexStatus.

type GetMonoVertexSummaryParams

type GetMonoVertexSummaryParams struct {
	// IfNoneMatch ETag from an earlier response
	IfNoneMatch *IfNoneMatch `json:"If-None-Match,omitempty"`
}

GetMonoVertexSummaryParams defines parameters for GetMonoVertexSummary.

type GetPipelineVertexStatusParams

type GetPipelineVertexStatusParams struct {
	// IfNoneMatch ETag from an earlier response
	IfNoneMatch *IfNoneMatch `json:"If-None-Match,omitempty"`
}

GetPipelineVertexStatusParams defines parameters for GetPipelineVertexStatus.

type GetPipelineVertexSummaryParams

type GetPipelineVertexSummaryParams struct {
	// IfNoneMatch ETag from an earlier response
	IfNoneMatch *IfNoneMatch `json:"If-None-Match,omitempty"`
}

GetPipelineVertexSummaryParams defines parameters for GetPipelineVertexSummary.

type GinServerOptions

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

GinServerOptions provides options for the Gin server.

type Health

type Health struct {
	Message *string     `json:"message,omitempty"`
	Reason  *string     `json:"reason,omitempty"`
	State   HealthState `json:"state"`
}

Health Compact health derived from Kubernetes Vertex or MonoVertex CR status. It excludes live Pod inspection and data-flow health.

type HealthState

type HealthState string

HealthState defines model for HealthState.

const (
	HealthStateCritical HealthState = "critical"
	HealthStateHealthy  HealthState = "healthy"
	HealthStateInactive HealthState = "inactive"
	HealthStateUnknown  HealthState = "unknown"
	HealthStateWarning  HealthState = "warning"
)

Defines values for HealthState.

type IfNoneMatch

type IfNoneMatch = string

IfNoneMatch defines model for IfNoneMatch.

type InternalServerError

type InternalServerError = Problem

InternalServerError defines model for InternalServerError.

type MiddlewareFunc

type MiddlewareFunc func(c *gin.Context)

type MonoVertex

type MonoVertex = string

MonoVertex defines model for MonoVertex.

type Namespace

type Namespace = string

Namespace defines model for Namespace.

type NotFound

type NotFound = Problem

NotFound defines model for NotFound.

type Pipeline

type Pipeline = string

Pipeline defines model for Pipeline.

type Problem

type Problem struct {
	Code       string       `json:"code"`
	Detail     string       `json:"detail"`
	Instance   string       `json:"instance"`
	Retryable  *bool        `json:"retryable,omitempty"`
	Status     int          `json:"status"`
	Title      string       `json:"title"`
	TraceId    *string      `json:"traceId,omitempty"`
	Type       string       `json:"type"`
	Violations *[]Violation `json:"violations,omitempty"`
}

Problem defines model for Problem.

type ReplicaStatus

type ReplicaStatus struct {
	Current      int64 `json:"current"`
	Desired      int64 `json:"desired"`
	Ready        int64 `json:"ready"`
	Updated      int64 `json:"updated"`
	UpdatedReady int64 `json:"updatedReady"`
}

ReplicaStatus defines model for ReplicaStatus.

type ServerInterface

type ServerInterface interface {
	// Get capabilities available to the current caller
	// (GET /capabilities)
	GetCapabilities(c *gin.Context)
	// Get detailed Kubernetes status for a MonoVertex
	// (GET /namespaces/{namespace}/mono-vertices/{monoVertex}/status)
	GetMonoVertexStatus(c *gin.Context, namespace Namespace, monoVertex MonoVertex, params GetMonoVertexStatusParams)
	// Get a compact MonoVertex summary
	// (GET /namespaces/{namespace}/mono-vertices/{monoVertex}/summary)
	GetMonoVertexSummary(c *gin.Context, namespace Namespace, monoVertex MonoVertex, params GetMonoVertexSummaryParams)
	// Get detailed Kubernetes status for a pipeline vertex
	// (GET /namespaces/{namespace}/pipelines/{pipeline}/vertices/{vertex}/status)
	GetPipelineVertexStatus(c *gin.Context, namespace Namespace, pipeline Pipeline, vertex Vertex, params GetPipelineVertexStatusParams)
	// Get a compact pipeline vertex summary
	// (GET /namespaces/{namespace}/pipelines/{pipeline}/vertices/{vertex}/summary)
	GetPipelineVertexSummary(c *gin.Context, namespace Namespace, pipeline Pipeline, vertex Vertex, params GetPipelineVertexSummaryParams)
}

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

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

GetCapabilities operation middleware

func (*ServerInterfaceWrapper) GetMonoVertexStatus

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

GetMonoVertexStatus operation middleware

func (*ServerInterfaceWrapper) GetMonoVertexSummary

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

GetMonoVertexSummary operation middleware

func (*ServerInterfaceWrapper) GetPipelineVertexStatus

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

GetPipelineVertexStatus operation middleware

func (*ServerInterfaceWrapper) GetPipelineVertexSummary

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

GetPipelineVertexSummary operation middleware

type TargetKind

type TargetKind string

TargetKind defines model for TargetKind.

const (
	TargetKindMonoVertex TargetKind = "MonoVertex"
	TargetKindVertex     TargetKind = "Vertex"
)

Defines values for TargetKind.

type TargetRef

type TargetRef struct {
	Kind      TargetKind `json:"kind"`
	Name      string     `json:"name"`
	Namespace string     `json:"namespace"`

	// Pipeline Pipeline name for Vertex targets; omitted for MonoVertex targets.
	Pipeline *string `json:"pipeline,omitempty"`
	Uid      string  `json:"uid"`
}

TargetRef defines model for TargetRef.

type Unauthorized

type Unauthorized = Problem

Unauthorized defines model for Unauthorized.

type ValidationFailed

type ValidationFailed = Problem

ValidationFailed defines model for ValidationFailed.

type Vertex

type Vertex = string

Vertex defines model for Vertex.

type VertexStatus

type VertexStatus struct {
	Conditions   []Condition `json:"conditions"`
	DesiredPhase string      `json:"desiredPhase"`
	Generation   int64       `json:"generation"`
	Message      *string     `json:"message,omitempty"`

	// ObservedAt Latest condition-transition or scaling timestamp from CR status, not response generation time.
	ObservedAt         time.Time     `json:"observedAt"`
	ObservedGeneration int64         `json:"observedGeneration"`
	Phase              string        `json:"phase"`
	Reason             *string       `json:"reason,omitempty"`
	Ref                TargetRef     `json:"ref"`
	Replicas           ReplicaStatus `json:"replicas"`
	TruncatedFields    *[]string     `json:"truncatedFields,omitempty"`
}

VertexStatus Detailed Kubernetes Vertex or MonoVertex CR status. It excludes live Pod inspection and data-flow health.

type VertexSummary

type VertexSummary struct {
	Capabilities []string  `json:"capabilities"`
	CreatedAt    time.Time `json:"createdAt"`
	DesiredPhase string    `json:"desiredPhase"`
	Generation   int64     `json:"generation"`

	// Health Compact health derived from Kubernetes Vertex or MonoVertex CR status. It excludes live Pod inspection and data-flow health.
	Health       Health     `json:"health"`
	LastScaledAt *time.Time `json:"lastScaledAt,omitempty"`

	// ObservedAt Latest condition-transition or scaling timestamp from CR status, not response generation time.
	ObservedAt         time.Time  `json:"observedAt"`
	ObservedGeneration int64      `json:"observedGeneration"`
	Phase              string     `json:"phase"`
	Ref                TargetRef  `json:"ref"`
	TruncatedFields    *[]string  `json:"truncatedFields,omitempty"`
	VertexType         VertexType `json:"vertexType"`
}

VertexSummary defines model for VertexSummary.

type VertexType

type VertexType string

VertexType defines model for VertexType.

const (
	VertexTypeMapUDF     VertexType = "MapUDF"
	VertexTypeMonoVertex VertexType = "MonoVertex"
	VertexTypeReduceUDF  VertexType = "ReduceUDF"
	VertexTypeSink       VertexType = "Sink"
	VertexTypeSource     VertexType = "Source"
)

Defines values for VertexType.

type Violation

type Violation struct {
	AllowedValues *[]string `json:"allowedValues,omitempty"`
	Field         string    `json:"field"`
	Message       string    `json:"message"`
	Reason        string    `json:"reason"`
}

Violation defines model for Violation.

Jump to

Keyboard shortcuts

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