Help us shape the future of Go! Take the 2026 Go Developer Survey

restapi

package
v1.18.16 Latest Latest
Warning

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

Go to latest
Published: Oct 23, 2026 License: Apache-2.0 Imports: 19 Imported by: 40

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CiliumAPIAPI added in v0.15.7

type CiliumAPIAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator

	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator

	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for the following mime types:
	//   - application/json
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for the following mime types:
	//   - application/json
	JSONProducer runtime.Producer

	// EndpointDeleteEndpointHandler sets the operation handler for the delete endpoint operation
	EndpointDeleteEndpointHandler endpoint.DeleteEndpointHandler
	// EndpointDeleteEndpointIDHandler sets the operation handler for the delete endpoint ID operation
	EndpointDeleteEndpointIDHandler endpoint.DeleteEndpointIDHandler
	// PolicyDeleteFqdnCacheHandler sets the operation handler for the delete fqdn cache operation
	PolicyDeleteFqdnCacheHandler policy.DeleteFqdnCacheHandler
	// IpamDeleteIpamIPHandler sets the operation handler for the delete ipam IP operation
	IpamDeleteIpamIPHandler ipam.DeleteIpamIPHandler
	// PolicyDeletePolicyHandler sets the operation handler for the delete policy operation
	PolicyDeletePolicyHandler policy.DeletePolicyHandler
	// PrefilterDeletePrefilterHandler sets the operation handler for the delete prefilter operation
	PrefilterDeletePrefilterHandler prefilter.DeletePrefilterHandler
	// RecorderDeleteRecorderIDHandler sets the operation handler for the delete recorder ID operation
	RecorderDeleteRecorderIDHandler recorder.DeleteRecorderIDHandler
	// BgpGetBgpPeersHandler sets the operation handler for the get bgp peers operation
	BgpGetBgpPeersHandler bgp.GetBgpPeersHandler
	// BgpGetBgpRoutePoliciesHandler sets the operation handler for the get bgp route policies operation
	BgpGetBgpRoutePoliciesHandler bgp.GetBgpRoutePoliciesHandler
	// BgpGetBgpRoutesHandler sets the operation handler for the get bgp routes operation
	BgpGetBgpRoutesHandler bgp.GetBgpRoutesHandler
	// DaemonGetCgroupDumpMetadataHandler sets the operation handler for the get cgroup dump metadata operation
	DaemonGetCgroupDumpMetadataHandler daemon.GetCgroupDumpMetadataHandler
	// DaemonGetClusterNodesHandler sets the operation handler for the get cluster nodes operation
	DaemonGetClusterNodesHandler daemon.GetClusterNodesHandler
	// DaemonGetConfigHandler sets the operation handler for the get config operation
	DaemonGetConfigHandler daemon.GetConfigHandler
	// DaemonGetDebuginfoHandler sets the operation handler for the get debuginfo operation
	DaemonGetDebuginfoHandler daemon.GetDebuginfoHandler
	// EndpointGetEndpointHandler sets the operation handler for the get endpoint operation
	EndpointGetEndpointHandler endpoint.GetEndpointHandler
	// EndpointGetEndpointIDHandler sets the operation handler for the get endpoint ID operation
	EndpointGetEndpointIDHandler endpoint.GetEndpointIDHandler
	// EndpointGetEndpointIDConfigHandler sets the operation handler for the get endpoint ID config operation
	EndpointGetEndpointIDConfigHandler endpoint.GetEndpointIDConfigHandler
	// EndpointGetEndpointIDHealthzHandler sets the operation handler for the get endpoint ID healthz operation
	EndpointGetEndpointIDHealthzHandler endpoint.GetEndpointIDHealthzHandler
	// EndpointGetEndpointIDLabelsHandler sets the operation handler for the get endpoint ID labels operation
	EndpointGetEndpointIDLabelsHandler endpoint.GetEndpointIDLabelsHandler
	// EndpointGetEndpointIDLogHandler sets the operation handler for the get endpoint ID log operation
	EndpointGetEndpointIDLogHandler endpoint.GetEndpointIDLogHandler
	// PolicyGetFqdnCacheHandler sets the operation handler for the get fqdn cache operation
	PolicyGetFqdnCacheHandler policy.GetFqdnCacheHandler
	// PolicyGetFqdnCacheIDHandler sets the operation handler for the get fqdn cache ID operation
	PolicyGetFqdnCacheIDHandler policy.GetFqdnCacheIDHandler
	// PolicyGetFqdnNamesHandler sets the operation handler for the get fqdn names operation
	PolicyGetFqdnNamesHandler policy.GetFqdnNamesHandler
	// DaemonGetHealthzHandler sets the operation handler for the get healthz operation
	DaemonGetHealthzHandler daemon.GetHealthzHandler
	// PolicyGetIPHandler sets the operation handler for the get IP operation
	PolicyGetIPHandler policy.GetIPHandler
	// PolicyGetIdentityHandler sets the operation handler for the get identity operation
	PolicyGetIdentityHandler policy.GetIdentityHandler
	// PolicyGetIdentityEndpointsHandler sets the operation handler for the get identity endpoints operation
	PolicyGetIdentityEndpointsHandler policy.GetIdentityEndpointsHandler
	// PolicyGetIdentityIDHandler sets the operation handler for the get identity ID operation
	PolicyGetIdentityIDHandler policy.GetIdentityIDHandler
	// ServiceGetLrpHandler sets the operation handler for the get lrp operation
	ServiceGetLrpHandler service.GetLrpHandler
	// DaemonGetMapHandler sets the operation handler for the get map operation
	DaemonGetMapHandler daemon.GetMapHandler
	// DaemonGetMapNameHandler sets the operation handler for the get map name operation
	DaemonGetMapNameHandler daemon.GetMapNameHandler
	// DaemonGetMapNameEventsHandler sets the operation handler for the get map name events operation
	DaemonGetMapNameEventsHandler daemon.GetMapNameEventsHandler
	// DaemonGetNodeIdsHandler sets the operation handler for the get node ids operation
	DaemonGetNodeIdsHandler daemon.GetNodeIdsHandler
	// PolicyGetPolicyHandler sets the operation handler for the get policy operation
	PolicyGetPolicyHandler policy.GetPolicyHandler
	// PolicyGetPolicySelectorsHandler sets the operation handler for the get policy selectors operation
	PolicyGetPolicySelectorsHandler policy.GetPolicySelectorsHandler
	// PrefilterGetPrefilterHandler sets the operation handler for the get prefilter operation
	PrefilterGetPrefilterHandler prefilter.GetPrefilterHandler
	// RecorderGetRecorderHandler sets the operation handler for the get recorder operation
	RecorderGetRecorderHandler recorder.GetRecorderHandler
	// RecorderGetRecorderIDHandler sets the operation handler for the get recorder ID operation
	RecorderGetRecorderIDHandler recorder.GetRecorderIDHandler
	// RecorderGetRecorderMasksHandler sets the operation handler for the get recorder masks operation
	RecorderGetRecorderMasksHandler recorder.GetRecorderMasksHandler
	// ServiceGetServiceHandler sets the operation handler for the get service operation
	ServiceGetServiceHandler service.GetServiceHandler
	// DaemonPatchConfigHandler sets the operation handler for the patch config operation
	DaemonPatchConfigHandler daemon.PatchConfigHandler
	// EndpointPatchEndpointIDHandler sets the operation handler for the patch endpoint ID operation
	EndpointPatchEndpointIDHandler endpoint.PatchEndpointIDHandler
	// EndpointPatchEndpointIDConfigHandler sets the operation handler for the patch endpoint ID config operation
	EndpointPatchEndpointIDConfigHandler endpoint.PatchEndpointIDConfigHandler
	// EndpointPatchEndpointIDLabelsHandler sets the operation handler for the patch endpoint ID labels operation
	EndpointPatchEndpointIDLabelsHandler endpoint.PatchEndpointIDLabelsHandler
	// PrefilterPatchPrefilterHandler sets the operation handler for the patch prefilter operation
	PrefilterPatchPrefilterHandler prefilter.PatchPrefilterHandler
	// IpamPostIpamHandler sets the operation handler for the post ipam operation
	IpamPostIpamHandler ipam.PostIpamHandler
	// IpamPostIpamIPHandler sets the operation handler for the post ipam IP operation
	IpamPostIpamIPHandler ipam.PostIpamIPHandler
	// EndpointPutEndpointIDHandler sets the operation handler for the put endpoint ID operation
	EndpointPutEndpointIDHandler endpoint.PutEndpointIDHandler
	// PolicyPutPolicyHandler sets the operation handler for the put policy operation
	PolicyPutPolicyHandler policy.PutPolicyHandler
	// RecorderPutRecorderIDHandler sets the operation handler for the put recorder ID operation
	RecorderPutRecorderIDHandler recorder.PutRecorderIDHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// PreServerShutdown is called before the HTTP(S) server is shutdown
	// This allows for custom functions to get executed before the HTTP(S) server stops accepting traffic
	PreServerShutdown func()

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

CiliumAPIAPI Cilium

func NewCiliumAPIAPI added in v0.15.7

func NewCiliumAPIAPI(spec *loads.Document) *CiliumAPIAPI

NewCiliumAPIAPI creates a new CiliumAPI instance

func (*CiliumAPIAPI) AddMiddlewareFor added in v0.15.7

func (o *CiliumAPIAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)

AddMiddlewareFor adds a http middleware to existing handler

func (*CiliumAPIAPI) AuthenticatorsFor added in v0.15.7

func (o *CiliumAPIAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*CiliumAPIAPI) Authorizer added in v0.15.7

func (o *CiliumAPIAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*CiliumAPIAPI) ConsumersFor added in v0.15.7

func (o *CiliumAPIAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.

func (*CiliumAPIAPI) Context added in v0.15.7

func (o *CiliumAPIAPI) Context() *middleware.Context

Context returns the middleware context for the cilium API API

func (*CiliumAPIAPI) DefaultConsumes added in v0.15.7

func (o *CiliumAPIAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*CiliumAPIAPI) DefaultProduces added in v0.15.7

func (o *CiliumAPIAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*CiliumAPIAPI) Formats added in v0.15.7

func (o *CiliumAPIAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*CiliumAPIAPI) HandlerFor added in v0.15.7

func (o *CiliumAPIAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*CiliumAPIAPI) Init added in v0.15.7

func (o *CiliumAPIAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*CiliumAPIAPI) ProducersFor added in v0.15.7

func (o *CiliumAPIAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.

func (*CiliumAPIAPI) RegisterConsumer added in v0.15.7

func (o *CiliumAPIAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*CiliumAPIAPI) RegisterFormat added in v0.15.7

func (o *CiliumAPIAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*CiliumAPIAPI) RegisterProducer added in v0.15.7

func (o *CiliumAPIAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*CiliumAPIAPI) Serve added in v0.15.7

func (o *CiliumAPIAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*CiliumAPIAPI) ServeErrorFor added in v0.15.7

func (o *CiliumAPIAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*CiliumAPIAPI) SetDefaultConsumes added in v0.15.7

func (o *CiliumAPIAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*CiliumAPIAPI) SetDefaultProduces added in v0.15.7

func (o *CiliumAPIAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*CiliumAPIAPI) SetSpec added in v0.15.7

func (o *CiliumAPIAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*CiliumAPIAPI) UseRedoc added in v0.15.7

func (o *CiliumAPIAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*CiliumAPIAPI) UseSwaggerUI added in v0.15.7

func (o *CiliumAPIAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*CiliumAPIAPI) Validate added in v0.15.7

func (o *CiliumAPIAPI) Validate() error

Validate validates the registrations in the CiliumAPIAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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