operations

package
v0.0.0-...-33e56a9 Latest Latest
Warning

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

Go to latest
Published: Jun 24, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EventEngineManagementAPIAPI

type EventEngineManagementAPIAPI 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

	// APIKeyHeaderAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key X-API-KEY provided in the header
	APIKeyHeaderAuth func(string) (interface{}, error)

	// APIKeyParamAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key api_key provided in the query
	APIKeyParamAuth func(string) (interface{}, error)

	// KeycloakAuth registers a function that takes an access token and a collection of required scopes and returns a principal
	// it performs authentication based on an oauth2 bearer token provided in the request
	KeycloakAuth func(string, []string) (interface{}, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// EventManagementAddEventHandler sets the operation handler for the add event operation
	EventManagementAddEventHandler event_management.AddEventHandler
	// TriggerManagementExecSampleHandler sets the operation handler for the exec sample operation
	TriggerManagementExecSampleHandler trigger_management.ExecSampleHandler
	// EventManagementGetHistoryHandler sets the operation handler for the get history operation
	EventManagementGetHistoryHandler event_management.GetHistoryHandler
	// EventManagementGetStateHandler sets the operation handler for the get state operation
	EventManagementGetStateHandler event_management.GetStateHandler
	// StatusManagementGetStatusHandler sets the operation handler for the get status operation
	StatusManagementGetStatusHandler status_management.GetStatusHandler
	// UsageManagementGetSystemUsageHandler sets the operation handler for the get system usage operation
	UsageManagementGetSystemUsageHandler usage_management.GetSystemUsageHandler
	// UsageManagementGetUsageHandler sets the operation handler for the get usage operation
	UsageManagementGetUsageHandler usage_management.GetUsageHandler
	// EventManagementListStatesHandler sets the operation handler for the list states operation
	EventManagementListStatesHandler event_management.ListStatesHandler
	// StatusManagementShowStatusHandler sets the operation handler for the show status operation
	StatusManagementShowStatusHandler status_management.ShowStatusHandler
	// 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
}

EventEngineManagementAPIAPI An API which supports creation, deletion, listing etc of Event Engine

func NewEventEngineManagementAPIAPI

func NewEventEngineManagementAPIAPI(spec *loads.Document) *EventEngineManagementAPIAPI

NewEventEngineManagementAPIAPI creates a new EventEngineManagementAPI instance

func (*EventEngineManagementAPIAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*EventEngineManagementAPIAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*EventEngineManagementAPIAPI) Authorizer

Authorizer returns the registered authorizer

func (*EventEngineManagementAPIAPI) ConsumersFor

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

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

func (*EventEngineManagementAPIAPI) Context

Context returns the middleware context for the event engine management API API

func (*EventEngineManagementAPIAPI) DefaultConsumes

func (o *EventEngineManagementAPIAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*EventEngineManagementAPIAPI) DefaultProduces

func (o *EventEngineManagementAPIAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*EventEngineManagementAPIAPI) Formats

Formats returns the registered string formats

func (*EventEngineManagementAPIAPI) HandlerFor

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

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

func (*EventEngineManagementAPIAPI) Init

func (o *EventEngineManagementAPIAPI) Init()

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

func (*EventEngineManagementAPIAPI) ProducersFor

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

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

func (*EventEngineManagementAPIAPI) RegisterConsumer

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

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

func (*EventEngineManagementAPIAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*EventEngineManagementAPIAPI) RegisterProducer

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

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

func (*EventEngineManagementAPIAPI) Serve

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

func (*EventEngineManagementAPIAPI) ServeErrorFor

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

ServeErrorFor gets a error handler for a given operation id

func (*EventEngineManagementAPIAPI) SetDefaultConsumes

func (o *EventEngineManagementAPIAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*EventEngineManagementAPIAPI) SetDefaultProduces

func (o *EventEngineManagementAPIAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*EventEngineManagementAPIAPI) SetSpec

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

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

func (*EventEngineManagementAPIAPI) UseRedoc

func (o *EventEngineManagementAPIAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*EventEngineManagementAPIAPI) UseSwaggerUI

func (o *EventEngineManagementAPIAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*EventEngineManagementAPIAPI) Validate

func (o *EventEngineManagementAPIAPI) Validate() error

Validate validates the registrations in the EventEngineManagementAPIAPI

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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