operations

Documentation

Index

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

Types

type AIGatewayAPI

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

	// APIAuthorizerAuth registers a function that takes a token and returns a principal
	// it performs authentication based on an api key Authorization provided in the header
	APIAuthorizerAuth func(string) (*auth.Principal, error)

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

	// ImageDeleteImageHandler sets the operation handler for the delete image operation
	ImageDeleteImageHandler image.DeleteImageHandler
	// JobDeleteJobHandler sets the operation handler for the delete job operation
	JobDeleteJobHandler job.DeleteJobHandler
	// NotebookDeleteNotebookHandler sets the operation handler for the delete notebook operation
	NotebookDeleteNotebookHandler notebook.DeleteNotebookHandler
	// WorkspaceDeleteWorkspaceHandler sets the operation handler for the delete workspace operation
	WorkspaceDeleteWorkspaceHandler workspace.DeleteWorkspaceHandler
	// AppErrorsGetAppErrorsHandler sets the operation handler for the get app errors operation
	AppErrorsGetAppErrorsHandler app_errors.GetAppErrorsHandler
	// AppGetConfigurationsHandler sets the operation handler for the get configurations operation
	AppGetConfigurationsHandler app.GetConfigurationsHandler
	// AppGetEndpointsHandler sets the operation handler for the get endpoints operation
	AppGetEndpointsHandler app.GetEndpointsHandler
	// NotebookGetIPythonNotebooksHandler sets the operation handler for the get i python notebooks operation
	NotebookGetIPythonNotebooksHandler notebook.GetIPythonNotebooksHandler
	// ImageGetImagesHandler sets the operation handler for the get images operation
	ImageGetImagesHandler image.GetImagesHandler
	// JobGetJobDetailHandler sets the operation handler for the get job detail operation
	JobGetJobDetailHandler job.GetJobDetailHandler
	// JobGetJobFilesHandler sets the operation handler for the get job files operation
	JobGetJobFilesHandler job.GetJobFilesHandler
	// JobGetJobLogsHandler sets the operation handler for the get job logs operation
	JobGetJobLogsHandler job.GetJobLogsHandler
	// JobGetJobsHandler sets the operation handler for the get jobs operation
	JobGetJobsHandler job.GetJobsHandler
	// RepositoryGetNgcImagesHandler sets the operation handler for the get ngc images operation
	RepositoryGetNgcImagesHandler repository.GetNgcImagesHandler
	// RepositoryGetNgcRepositoriesHandler sets the operation handler for the get ngc repositories operation
	RepositoryGetNgcRepositoriesHandler repository.GetNgcRepositoriesHandler
	// NotebookGetNotebookDetailsHandler sets the operation handler for the get notebook details operation
	NotebookGetNotebookDetailsHandler notebook.GetNotebookDetailsHandler
	// NotebookGetNotebooksHandler sets the operation handler for the get notebooks operation
	NotebookGetNotebooksHandler notebook.GetNotebooksHandler
	// RepositoryGetRemoteImagesHandler sets the operation handler for the get remote images operation
	RepositoryGetRemoteImagesHandler repository.GetRemoteImagesHandler
	// RepositoryGetRemoteRepositoriesHandler sets the operation handler for the get remote repositories operation
	RepositoryGetRemoteRepositoriesHandler repository.GetRemoteRepositoriesHandler
	// RescaleGetRescaleApplicationHandler sets the operation handler for the get rescale application operation
	RescaleGetRescaleApplicationHandler rescale.GetRescaleApplicationHandler
	// RescaleGetRescaleApplicationVersionHandler sets the operation handler for the get rescale application version operation
	RescaleGetRescaleApplicationVersionHandler rescale.GetRescaleApplicationVersionHandler
	// RescaleGetRescaleCoreTypesHandler sets the operation handler for the get rescale core types operation
	RescaleGetRescaleCoreTypesHandler rescale.GetRescaleCoreTypesHandler
	// AppGetVersionsHandler sets the operation handler for the get versions operation
	AppGetVersionsHandler app.GetVersionsHandler
	// WorkspaceGetWorkspacesHandler sets the operation handler for the get workspaces operation
	WorkspaceGetWorkspacesHandler workspace.GetWorkspacesHandler
	// JobModifyJobHandler sets the operation handler for the modify job operation
	JobModifyJobHandler job.ModifyJobHandler
	// NotebookModifyNotebookHandler sets the operation handler for the modify notebook operation
	NotebookModifyNotebookHandler notebook.ModifyNotebookHandler
	// AppPostConfigurationsHandler sets the operation handler for the post configurations operation
	AppPostConfigurationsHandler app.PostConfigurationsHandler
	// ImagePostNewImageHandler sets the operation handler for the post new image operation
	ImagePostNewImageHandler image.PostNewImageHandler
	// JobPostNewJobHandler sets the operation handler for the post new job operation
	JobPostNewJobHandler job.PostNewJobHandler
	// NotebookPostNewNotebookHandler sets the operation handler for the post new notebook operation
	NotebookPostNewNotebookHandler notebook.PostNewNotebookHandler
	// AppPostNewSessionHandler sets the operation handler for the post new session operation
	AppPostNewSessionHandler app.PostNewSessionHandler
	// 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
}

AIGatewayAPI A platform for machine learning & high performance computing

func NewAIGatewayAPI

func NewAIGatewayAPI(spec *loads.Document) *AIGatewayAPI

NewAIGatewayAPI creates a new AIGateway instance

func (*AIGatewayAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*AIGatewayAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*AIGatewayAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*AIGatewayAPI) ConsumersFor

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

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

func (*AIGatewayAPI) Context

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

Context returns the middleware context for the a i gateway API

func (*AIGatewayAPI) DefaultConsumes

func (o *AIGatewayAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*AIGatewayAPI) DefaultProduces

func (o *AIGatewayAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*AIGatewayAPI) Formats

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

Formats returns the registered string formats

func (*AIGatewayAPI) HandlerFor

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

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

func (*AIGatewayAPI) Init

func (o *AIGatewayAPI) Init()

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

func (*AIGatewayAPI) ProducersFor

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

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

func (*AIGatewayAPI) RegisterConsumer

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

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

func (*AIGatewayAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*AIGatewayAPI) RegisterProducer

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

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

func (*AIGatewayAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*AIGatewayAPI) SetDefaultConsumes

func (o *AIGatewayAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*AIGatewayAPI) SetDefaultProduces

func (o *AIGatewayAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*AIGatewayAPI) SetSpec

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

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

func (*AIGatewayAPI) UseRedoc

func (o *AIGatewayAPI) UseRedoc()

UseRedoc for documentation at /docs

func (*AIGatewayAPI) UseSwaggerUI

func (o *AIGatewayAPI) UseSwaggerUI()

UseSwaggerUI for documentation at /docs

func (*AIGatewayAPI) Validate

func (o *AIGatewayAPI) Validate() error

Validate validates the registrations in the AIGatewayAPI