Documentation
¶
Index ¶
- type FunctionManagerAPI
- func (o *FunctionManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *FunctionManagerAPI) Authorizer() runtime.Authorizer
- func (o *FunctionManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *FunctionManagerAPI) Context() *middleware.Context
- func (o *FunctionManagerAPI) DefaultConsumes() string
- func (o *FunctionManagerAPI) DefaultProduces() string
- func (o *FunctionManagerAPI) Formats() strfmt.Registry
- func (o *FunctionManagerAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *FunctionManagerAPI) Init()
- func (o *FunctionManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *FunctionManagerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *FunctionManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *FunctionManagerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *FunctionManagerAPI) Serve(builder middleware.Builder) http.Handler
- func (o *FunctionManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *FunctionManagerAPI) SetDefaultConsumes(mediaType string)
- func (o *FunctionManagerAPI) SetDefaultProduces(mediaType string)
- func (o *FunctionManagerAPI) SetSpec(spec *loads.Document)
- func (o *FunctionManagerAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FunctionManagerAPI ¶
type FunctionManagerAPI struct {
Middleware func(middleware.Builder) http.Handler
// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
// It has a default implemention 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 implemention 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 implemention 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
// BearerAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key Authorization provided in the header
BearerAuth func(string) (interface{}, error)
// CookieAuth registers a function that takes a token and returns a principal
// it performs authentication based on an api key Cookie provided in the header
CookieAuth func(string) (interface{}, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// StoreAddFunctionHandler sets the operation handler for the add function operation
StoreAddFunctionHandler store.AddFunctionHandler
// StoreDeleteFunctionHandler sets the operation handler for the delete function operation
StoreDeleteFunctionHandler store.DeleteFunctionHandler
// StoreGetFunctionHandler sets the operation handler for the get function operation
StoreGetFunctionHandler store.GetFunctionHandler
// StoreGetFunctionsHandler sets the operation handler for the get functions operation
StoreGetFunctionsHandler store.GetFunctionsHandler
// RunnerGetRunHandler sets the operation handler for the get run operation
RunnerGetRunHandler runner.GetRunHandler
// RunnerGetRunsHandler sets the operation handler for the get runs operation
RunnerGetRunsHandler runner.GetRunsHandler
// RunnerRunFunctionHandler sets the operation handler for the run function operation
RunnerRunFunctionHandler runner.RunFunctionHandler
// StoreUpdateFunctionHandler sets the operation handler for the update function operation
StoreUpdateFunctionHandler store.UpdateFunctionHandler
// 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
}
FunctionManagerAPI VMware Dispatch Function Manager
func NewFunctionManagerAPI ¶
func NewFunctionManagerAPI(spec *loads.Document) *FunctionManagerAPI
NewFunctionManagerAPI creates a new FunctionManager instance
func (*FunctionManagerAPI) AuthenticatorsFor ¶
func (o *FunctionManagerAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*FunctionManagerAPI) Authorizer ¶
func (o *FunctionManagerAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*FunctionManagerAPI) ConsumersFor ¶
func (o *FunctionManagerAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types
func (*FunctionManagerAPI) Context ¶
func (o *FunctionManagerAPI) Context() *middleware.Context
Context returns the middleware context for the function manager API
func (*FunctionManagerAPI) DefaultConsumes ¶
func (o *FunctionManagerAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*FunctionManagerAPI) DefaultProduces ¶
func (o *FunctionManagerAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*FunctionManagerAPI) Formats ¶
func (o *FunctionManagerAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*FunctionManagerAPI) HandlerFor ¶
func (o *FunctionManagerAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*FunctionManagerAPI) Init ¶
func (o *FunctionManagerAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*FunctionManagerAPI) ProducersFor ¶
func (o *FunctionManagerAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types
func (*FunctionManagerAPI) RegisterConsumer ¶ added in v0.1.13
func (o *FunctionManagerAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*FunctionManagerAPI) RegisterFormat ¶
func (o *FunctionManagerAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*FunctionManagerAPI) RegisterProducer ¶ added in v0.1.13
func (o *FunctionManagerAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*FunctionManagerAPI) Serve ¶
func (o *FunctionManagerAPI) 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 (*FunctionManagerAPI) ServeErrorFor ¶
func (o *FunctionManagerAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*FunctionManagerAPI) SetDefaultConsumes ¶
func (o *FunctionManagerAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*FunctionManagerAPI) SetDefaultProduces ¶
func (o *FunctionManagerAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*FunctionManagerAPI) SetSpec ¶
func (o *FunctionManagerAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*FunctionManagerAPI) Validate ¶
func (o *FunctionManagerAPI) Validate() error
Validate validates the registrations in the FunctionManagerAPI