Documentation
¶
Index ¶
- type TocAPI
- func (o *TocAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *TocAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *TocAPI) Authorizer() runtime.Authorizer
- func (o *TocAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *TocAPI) Context() *middleware.Context
- func (o *TocAPI) DefaultConsumes() string
- func (o *TocAPI) DefaultProduces() string
- func (o *TocAPI) Formats() strfmt.Registry
- func (o *TocAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *TocAPI) Init()
- func (o *TocAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *TocAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *TocAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *TocAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *TocAPI) Serve(builder middleware.Builder) http.Handler
- func (o *TocAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *TocAPI) SetDefaultConsumes(mediaType string)
- func (o *TocAPI) SetDefaultProduces(mediaType string)
- func (o *TocAPI) SetSpec(spec *loads.Document)
- func (o *TocAPI) UseRedoc()
- func (o *TocAPI) UseSwaggerUI()
- func (o *TocAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TocAPI ¶
type TocAPI 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
// LogExportLogHandler sets the operation handler for the export log operation
LogExportLogHandler logops.ExportLogHandler
// ArchiveGetArchiveByIDHandler sets the operation handler for the get archive by Id operation
ArchiveGetArchiveByIDHandler archive.GetArchiveByIDHandler
// ArchiveGetArchivesHandler sets the operation handler for the get archives operation
ArchiveGetArchivesHandler archive.GetArchivesHandler
// BackupGetBackupByIDHandler sets the operation handler for the get backup by Id operation
BackupGetBackupByIDHandler backup.GetBackupByIDHandler
// BackupGetBackupsHandler sets the operation handler for the get backups operation
BackupGetBackupsHandler backup.GetBackupsHandler
// QuotaGetQuotasHandler sets the operation handler for the get quotas operation
QuotaGetQuotasHandler quota.GetQuotasHandler
// RestorationGetRestorationByIDHandler sets the operation handler for the get restoration by Id operation
RestorationGetRestorationByIDHandler restoration.GetRestorationByIDHandler
// RestorationGetRestorationsHandler sets the operation handler for the get restorations operation
RestorationGetRestorationsHandler restoration.GetRestorationsHandler
// TransferGetTransferByIDHandler sets the operation handler for the get transfer by Id operation
TransferGetTransferByIDHandler transfer.GetTransferByIDHandler
// TransferGetTransfersHandler sets the operation handler for the get transfers operation
TransferGetTransfersHandler transfer.GetTransfersHandler
// ArchiveNewArchiveHandler sets the operation handler for the new archive operation
ArchiveNewArchiveHandler archive.NewArchiveHandler
// BackupNewBackupHandler sets the operation handler for the new backup operation
BackupNewBackupHandler backup.NewBackupHandler
// RestorationNewRestorationHandler sets the operation handler for the new restoration operation
RestorationNewRestorationHandler restoration.NewRestorationHandler
// SynchronizationNewSynchronizationHandler sets the operation handler for the new synchronization operation
SynchronizationNewSynchronizationHandler synchronization.NewSynchronizationHandler
// TransferNewTransferHandler sets the operation handler for the new transfer operation
TransferNewTransferHandler transfer.NewTransferHandler
// ArchiveUpdateArchiveHandler sets the operation handler for the update archive operation
ArchiveUpdateArchiveHandler archive.UpdateArchiveHandler
// BackupUpdateBackupHandler sets the operation handler for the update backup operation
BackupUpdateBackupHandler backup.UpdateBackupHandler
// LogUpdateLogHandler sets the operation handler for the update log operation
LogUpdateLogHandler logops.UpdateLogHandler
// RestorationUpdateRestorationHandler sets the operation handler for the update restoration operation
RestorationUpdateRestorationHandler restoration.UpdateRestorationHandler
// SynchronizationUpdateSynchronizationHandler sets the operation handler for the update synchronization operation
SynchronizationUpdateSynchronizationHandler synchronization.UpdateSynchronizationHandler
// TransferUpdateTransferHandler sets the operation handler for the update transfer operation
TransferUpdateTransferHandler transfer.UpdateTransferHandler
// 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
}
TocAPI An API to create backup and restoration
func (*TocAPI) AddMiddlewareFor ¶
func (o *TocAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*TocAPI) AuthenticatorsFor ¶
func (o *TocAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*TocAPI) Authorizer ¶
func (o *TocAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*TocAPI) ConsumersFor ¶
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*TocAPI) Context ¶
func (o *TocAPI) Context() *middleware.Context
Context returns the middleware context for the toc API
func (*TocAPI) DefaultConsumes ¶
DefaultConsumes returns the default consumes media type
func (*TocAPI) DefaultProduces ¶
DefaultProduces returns the default produces media type
func (*TocAPI) HandlerFor ¶
HandlerFor gets a http.Handler for the provided operation method and path
func (*TocAPI) Init ¶
func (o *TocAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*TocAPI) ProducersFor ¶
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*TocAPI) RegisterConsumer ¶
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*TocAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*TocAPI) RegisterProducer ¶
RegisterProducer allows you to add (or override) a producer for a media type.
func (*TocAPI) Serve ¶
func (o *TocAPI) 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 (*TocAPI) ServeErrorFor ¶
ServeErrorFor gets a error handler for a given operation id
func (*TocAPI) SetDefaultConsumes ¶
SetDefaultConsumes returns the default consumes media type
func (*TocAPI) SetDefaultProduces ¶
SetDefaultProduces sets the default produces media type
func (*TocAPI) UseSwaggerUI ¶
func (o *TocAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs