AlertmanagerAPI API of the Prometheus Alertmanager (https://github.com/prometheus/alertmanager)
type AlertmanagerAPI 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
// SilenceDeleteSilenceHandler sets the operation handler for the delete silence operation
SilenceDeleteSilenceHandler silence.DeleteSilenceHandler
// AlertgroupGetAlertGroupsHandler sets the operation handler for the get alert groups operation
AlertgroupGetAlertGroupsHandler alertgroup.GetAlertGroupsHandler
// AlertGetAlertsHandler sets the operation handler for the get alerts operation
AlertGetAlertsHandler alert.GetAlertsHandler
// ReceiverGetReceiversHandler sets the operation handler for the get receivers operation
ReceiverGetReceiversHandler receiver.GetReceiversHandler
// SilenceGetSilenceHandler sets the operation handler for the get silence operation
SilenceGetSilenceHandler silence.GetSilenceHandler
// SilenceGetSilencesHandler sets the operation handler for the get silences operation
SilenceGetSilencesHandler silence.GetSilencesHandler
// GeneralGetStatusHandler sets the operation handler for the get status operation
GeneralGetStatusHandler general.GetStatusHandler
// AlertPostAlertsHandler sets the operation handler for the post alerts operation
AlertPostAlertsHandler alert.PostAlertsHandler
// SilencePostSilencesHandler sets the operation handler for the post silences operation
SilencePostSilencesHandler silence.PostSilencesHandler
// 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
}
func NewAlertmanagerAPI(spec *loads.Document) *AlertmanagerAPI
NewAlertmanagerAPI creates a new Alertmanager instance
func (o *AlertmanagerAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (o *AlertmanagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (o *AlertmanagerAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (o *AlertmanagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (o *AlertmanagerAPI) Context() *middleware.Context
Context returns the middleware context for the alertmanager API
func (o *AlertmanagerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (o *AlertmanagerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (o *AlertmanagerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (o *AlertmanagerAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (o *AlertmanagerAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (o *AlertmanagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (o *AlertmanagerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (o *AlertmanagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (o *AlertmanagerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (o *AlertmanagerAPI) 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 (o *AlertmanagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (o *AlertmanagerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (o *AlertmanagerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (o *AlertmanagerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (o *AlertmanagerAPI) UseRedoc()
UseRedoc for documentation at /docs
func (o *AlertmanagerAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (o *AlertmanagerAPI) Validate() error
Validate validates the registrations in the AlertmanagerAPI