Documentation ¶
Index ¶
- type MonitorAPI
- func (o *MonitorAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *MonitorAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *MonitorAPI) Authorizer() runtime.Authorizer
- func (o *MonitorAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *MonitorAPI) Context() *middleware.Context
- func (o *MonitorAPI) DefaultConsumes() string
- func (o *MonitorAPI) DefaultProduces() string
- func (o *MonitorAPI) Formats() strfmt.Registry
- func (o *MonitorAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *MonitorAPI) Init()
- func (o *MonitorAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *MonitorAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *MonitorAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *MonitorAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *MonitorAPI) Serve(builder middleware.Builder) http.Handler
- func (o *MonitorAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *MonitorAPI) SetDefaultConsumes(mediaType string)
- func (o *MonitorAPI) SetDefaultProduces(mediaType string)
- func (o *MonitorAPI) SetSpec(spec *loads.Document)
- func (o *MonitorAPI) UseRedoc()
- func (o *MonitorAPI) UseSwaggerUI()
- func (o *MonitorAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type MonitorAPI ¶
type MonitorAPI 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 // MonitorProcessHandler sets the operation handler for the process operation MonitorProcessHandler monitor.ProcessHandler // 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 }
MonitorAPI the monitor API
func NewMonitorAPI ¶
func NewMonitorAPI(spec *loads.Document) *MonitorAPI
NewMonitorAPI creates a new Monitor instance
func (*MonitorAPI) AddMiddlewareFor ¶
func (o *MonitorAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*MonitorAPI) AuthenticatorsFor ¶
func (o *MonitorAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*MonitorAPI) Authorizer ¶
func (o *MonitorAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*MonitorAPI) ConsumersFor ¶
func (o *MonitorAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*MonitorAPI) Context ¶
func (o *MonitorAPI) Context() *middleware.Context
Context returns the middleware context for the monitor API
func (*MonitorAPI) DefaultConsumes ¶
func (o *MonitorAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*MonitorAPI) DefaultProduces ¶
func (o *MonitorAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*MonitorAPI) Formats ¶
func (o *MonitorAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*MonitorAPI) HandlerFor ¶
func (o *MonitorAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*MonitorAPI) Init ¶
func (o *MonitorAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*MonitorAPI) ProducersFor ¶
func (o *MonitorAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*MonitorAPI) RegisterConsumer ¶
func (o *MonitorAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*MonitorAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*MonitorAPI) RegisterProducer ¶
func (o *MonitorAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*MonitorAPI) Serve ¶
func (o *MonitorAPI) 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 (*MonitorAPI) ServeErrorFor ¶
func (o *MonitorAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*MonitorAPI) SetDefaultConsumes ¶
func (o *MonitorAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*MonitorAPI) SetDefaultProduces ¶
func (o *MonitorAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*MonitorAPI) SetSpec ¶
func (o *MonitorAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*MonitorAPI) UseSwaggerUI ¶
func (o *MonitorAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*MonitorAPI) Validate ¶
func (o *MonitorAPI) Validate() error
Validate validates the registrations in the MonitorAPI