operations

Documentation

Index

• type WorkflowExecutorAPI
  • func NewWorkflowExecutorAPI(spec *loads.Document) *WorkflowExecutorAPI
  • func (o *WorkflowExecutorAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
  • func (o *WorkflowExecutorAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
  • func (o *WorkflowExecutorAPI) Authorizer() runtime.Authorizer
  • func (o *WorkflowExecutorAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
  • func (o *WorkflowExecutorAPI) Context() *middleware.Context
  • func (o *WorkflowExecutorAPI) DefaultConsumes() string
  • func (o *WorkflowExecutorAPI) DefaultProduces() string
  • func (o *WorkflowExecutorAPI) Formats() strfmt.Registry
  • func (o *WorkflowExecutorAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *WorkflowExecutorAPI) Init()
  • func (o *WorkflowExecutorAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
  • func (o *WorkflowExecutorAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
  • func (o *WorkflowExecutorAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *WorkflowExecutorAPI) RegisterProducer(mediaType string, producer runtime.Producer)
  • func (o *WorkflowExecutorAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *WorkflowExecutorAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *WorkflowExecutorAPI) SetDefaultConsumes(mediaType string)
  • func (o *WorkflowExecutorAPI) SetDefaultProduces(mediaType string)
  • func (o *WorkflowExecutorAPI) SetSpec(spec *loads.Document)
  • func (o *WorkflowExecutorAPI) UseRedoc()
  • func (o *WorkflowExecutorAPI) UseSwaggerUI()
  • func (o *WorkflowExecutorAPI) Validate() error

Types

type WorkflowExecutorAPI

type WorkflowExecutorAPI 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
	// TextEventStreamProducer registers a producer for the following mime types:
	//   - text/event-stream
	TextEventStreamProducer runtime.Producer

	// SouthboundGetJobsHandler sets the operation handler for the get jobs operation
	SouthboundGetJobsHandler southbound.GetJobsHandler
	// SouthboundGetJobsEventsHandler sets the operation handler for the get jobs events operation
	SouthboundGetJobsEventsHandler southbound.GetJobsEventsHandler
	// SouthboundGetJobsIDHandler sets the operation handler for the get jobs ID operation
	SouthboundGetJobsIDHandler southbound.GetJobsIDHandler
	// SouthboundGetJobsIDDefinitionHandler sets the operation handler for the get jobs ID definition operation
	SouthboundGetJobsIDDefinitionHandler southbound.GetJobsIDDefinitionHandler
	// SouthboundGetJobsIDStatusHandler sets the operation handler for the get jobs ID status operation
	SouthboundGetJobsIDStatusHandler southbound.GetJobsIDStatusHandler
	// SouthboundGetJobsIDTagsHandler sets the operation handler for the get jobs ID tags operation
	SouthboundGetJobsIDTagsHandler southbound.GetJobsIDTagsHandler
	// SouthboundGetWorkflowsHandler sets the operation handler for the get workflows operation
	SouthboundGetWorkflowsHandler southbound.GetWorkflowsHandler
	// SouthboundGetWorkflowsNameHandler sets the operation handler for the get workflows name operation
	SouthboundGetWorkflowsNameHandler southbound.GetWorkflowsNameHandler
	// SouthboundPutJobsIDDefinitionHandler sets the operation handler for the put jobs ID definition operation
	SouthboundPutJobsIDDefinitionHandler southbound.PutJobsIDDefinitionHandler
	// SouthboundPutJobsIDStatusHandler sets the operation handler for the put jobs ID status operation
	SouthboundPutJobsIDStatusHandler southbound.PutJobsIDStatusHandler

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

WorkflowExecutorAPI the workflow executor API

func NewWorkflowExecutorAPI

func NewWorkflowExecutorAPI(spec *loads.Document) *WorkflowExecutorAPI

NewWorkflowExecutorAPI creates a new WorkflowExecutor instance

func (*WorkflowExecutorAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*WorkflowExecutorAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*WorkflowExecutorAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*WorkflowExecutorAPI) ConsumersFor

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

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

func (*WorkflowExecutorAPI) Context

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

Context returns the middleware context for the workflow executor API

func (*WorkflowExecutorAPI) DefaultConsumes

func (o *WorkflowExecutorAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*WorkflowExecutorAPI) DefaultProduces

func (o *WorkflowExecutorAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*WorkflowExecutorAPI) Formats

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

Formats returns the registered string formats

func (*WorkflowExecutorAPI) HandlerFor

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

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

func (*WorkflowExecutorAPI) Init

func (o *WorkflowExecutorAPI) Init()

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

func (*WorkflowExecutorAPI) ProducersFor

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

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

func (*WorkflowExecutorAPI) RegisterConsumer

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

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

func (*WorkflowExecutorAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*WorkflowExecutorAPI) RegisterProducer

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

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

func (*WorkflowExecutorAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*WorkflowExecutorAPI) SetDefaultConsumes

func (o *WorkflowExecutorAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*WorkflowExecutorAPI) SetDefaultProduces

func (o *WorkflowExecutorAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*WorkflowExecutorAPI) SetSpec

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

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

func (*WorkflowExecutorAPI) UseRedoc

func (o *WorkflowExecutorAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*WorkflowExecutorAPI) UseSwaggerUI

func (o *WorkflowExecutorAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*WorkflowExecutorAPI) Validate

func (o *WorkflowExecutorAPI) Validate() error

Validate validates the registrations in the WorkflowExecutorAPI