cilium: github.com/cilium/cilium/api/v1/server/restapi Index | Files | Directories

package restapi

import "github.com/cilium/cilium/api/v1/server/restapi"

Index

Package Files

cilium_api.go

type CiliumAPI Uses

type CiliumAPI 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 a "application/json" mime type
    JSONConsumer runtime.Consumer

    // JSONProducer registers a producer for a "application/json" mime type
    JSONProducer runtime.Producer

    // 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
    // ServiceDeleteServiceIDHandler sets the operation handler for the delete service ID operation
    ServiceDeleteServiceIDHandler service.DeleteServiceIDHandler
    // 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
    // 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
    // MetricsGetMetricsHandler sets the operation handler for the get metrics operation
    MetricsGetMetricsHandler metrics.GetMetricsHandler
    // PolicyGetPolicyHandler sets the operation handler for the get policy operation
    PolicyGetPolicyHandler policy.GetPolicyHandler
    // PolicyGetPolicyResolveHandler sets the operation handler for the get policy resolve operation
    PolicyGetPolicyResolveHandler policy.GetPolicyResolveHandler
    // 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
    // ServiceGetServiceHandler sets the operation handler for the get service operation
    ServiceGetServiceHandler service.GetServiceHandler
    // ServiceGetServiceIDHandler sets the operation handler for the get service ID operation
    ServiceGetServiceIDHandler service.GetServiceIDHandler
    // 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
    // ServicePutServiceIDHandler sets the operation handler for the put service ID operation
    ServicePutServiceIDHandler service.PutServiceIDHandler

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

    // 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
}

CiliumAPI Cilium

func NewCiliumAPI Uses

func NewCiliumAPI(spec *loads.Document) *CiliumAPI

NewCiliumAPI creates a new Cilium instance

func (*CiliumAPI) AuthenticatorsFor Uses

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*CiliumAPI) Authorizer Uses

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

Authorizer returns the registered authorizer

func (*CiliumAPI) ConsumersFor Uses

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

ConsumersFor gets the consumers for the specified media types

func (*CiliumAPI) Context Uses

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

Context returns the middleware context for the cilium API

func (*CiliumAPI) DefaultConsumes Uses

func (o *CiliumAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*CiliumAPI) DefaultProduces Uses

func (o *CiliumAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*CiliumAPI) Formats Uses

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

Formats returns the registered string formats

func (*CiliumAPI) HandlerFor Uses

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

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

func (*CiliumAPI) Init Uses

func (o *CiliumAPI) Init()

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

func (*CiliumAPI) ProducersFor Uses

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

ProducersFor gets the producers for the specified media types

func (*CiliumAPI) RegisterConsumer Uses

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

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

func (*CiliumAPI) RegisterFormat Uses

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

RegisterFormat registers a custom format validator

func (*CiliumAPI) RegisterProducer Uses

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

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

func (*CiliumAPI) Serve Uses

func (o *CiliumAPI) 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 (*CiliumAPI) ServeErrorFor Uses

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

ServeErrorFor gets a error handler for a given operation id

func (*CiliumAPI) SetDefaultConsumes Uses

func (o *CiliumAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*CiliumAPI) SetDefaultProduces Uses

func (o *CiliumAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*CiliumAPI) SetSpec Uses

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

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

func (*CiliumAPI) Validate Uses

func (o *CiliumAPI) Validate() error

Validate validates the registrations in the CiliumAPI

Directories

PathSynopsis
daemon
endpoint
ipam
metrics
policy
prefilter
service

Package restapi imports 18 packages (graph) and is imported by 19 packages. Updated 2020-02-19. Refresh now. Tools for package owners.