Documentation ¶
Index ¶
- type ScaleShiftAPI
- func (o *ScaleShiftAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *ScaleShiftAPI) Authorizer() runtime.Authorizer
- func (o *ScaleShiftAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *ScaleShiftAPI) Context() *middleware.Context
- func (o *ScaleShiftAPI) DefaultConsumes() string
- func (o *ScaleShiftAPI) DefaultProduces() string
- func (o *ScaleShiftAPI) Formats() strfmt.Registry
- func (o *ScaleShiftAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *ScaleShiftAPI) Init()
- func (o *ScaleShiftAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *ScaleShiftAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *ScaleShiftAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *ScaleShiftAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *ScaleShiftAPI) Serve(builder middleware.Builder) http.Handler
- func (o *ScaleShiftAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *ScaleShiftAPI) SetDefaultConsumes(mediaType string)
- func (o *ScaleShiftAPI) SetDefaultProduces(mediaType string)
- func (o *ScaleShiftAPI) SetSpec(spec *loads.Document)
- func (o *ScaleShiftAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ScaleShiftAPI ¶
type ScaleShiftAPI 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 // 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 ipython 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) // 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 }
ScaleShiftAPI A platform for machine learning & high performance computing
func NewScaleShiftAPI ¶
func NewScaleShiftAPI(spec *loads.Document) *ScaleShiftAPI
NewScaleShiftAPI creates a new ScaleShift instance
func (*ScaleShiftAPI) AuthenticatorsFor ¶
func (o *ScaleShiftAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*ScaleShiftAPI) Authorizer ¶
func (o *ScaleShiftAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*ScaleShiftAPI) ConsumersFor ¶
func (o *ScaleShiftAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types
func (*ScaleShiftAPI) Context ¶
func (o *ScaleShiftAPI) Context() *middleware.Context
Context returns the middleware context for the scale shift API
func (*ScaleShiftAPI) DefaultConsumes ¶
func (o *ScaleShiftAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*ScaleShiftAPI) DefaultProduces ¶
func (o *ScaleShiftAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*ScaleShiftAPI) Formats ¶
func (o *ScaleShiftAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*ScaleShiftAPI) HandlerFor ¶
func (o *ScaleShiftAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*ScaleShiftAPI) Init ¶
func (o *ScaleShiftAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*ScaleShiftAPI) ProducersFor ¶
func (o *ScaleShiftAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types
func (*ScaleShiftAPI) RegisterConsumer ¶
func (o *ScaleShiftAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*ScaleShiftAPI) RegisterFormat ¶
func (o *ScaleShiftAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*ScaleShiftAPI) RegisterProducer ¶
func (o *ScaleShiftAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*ScaleShiftAPI) Serve ¶
func (o *ScaleShiftAPI) 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 (*ScaleShiftAPI) ServeErrorFor ¶
func (o *ScaleShiftAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*ScaleShiftAPI) SetDefaultConsumes ¶
func (o *ScaleShiftAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*ScaleShiftAPI) SetDefaultProduces ¶
func (o *ScaleShiftAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*ScaleShiftAPI) SetSpec ¶
func (o *ScaleShiftAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*ScaleShiftAPI) Validate ¶
func (o *ScaleShiftAPI) Validate() error
Validate validates the registrations in the ScaleShiftAPI