Documentation
¶
Index ¶
- type ConsoleAPI
- func (o *ConsoleAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *ConsoleAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *ConsoleAPI) Authorizer() runtime.Authorizer
- func (o *ConsoleAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *ConsoleAPI) Context() *middleware.Context
- func (o *ConsoleAPI) DefaultConsumes() string
- func (o *ConsoleAPI) DefaultProduces() string
- func (o *ConsoleAPI) Formats() strfmt.Registry
- func (o *ConsoleAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *ConsoleAPI) Init()
- func (o *ConsoleAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *ConsoleAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *ConsoleAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *ConsoleAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *ConsoleAPI) Serve(builder middleware.Builder) http.Handler
- func (o *ConsoleAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *ConsoleAPI) SetDefaultConsumes(mediaType string)
- func (o *ConsoleAPI) SetDefaultProduces(mediaType string)
- func (o *ConsoleAPI) SetSpec(spec *loads.Document)
- func (o *ConsoleAPI) UseRedoc()
- func (o *ConsoleAPI) UseSwaggerUI()
- func (o *ConsoleAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConsoleAPI ¶
type ConsoleAPI 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
// MultipartformConsumer registers a consumer for the following mime types:
// - multipart/form-data
MultipartformConsumer runtime.Consumer
// BinProducer registers a producer for the following mime types:
// - application/octet-stream
BinProducer runtime.Producer
// JSONProducer registers a producer for the following mime types:
// - application/json
JSONProducer runtime.Producer
// KeyAuth 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
KeyAuth func(string, []string) (*models.Principal, error)
// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
APIAuthorizer runtime.Authorizer
// UserAPIAccountChangePasswordHandler sets the operation handler for the account change password operation
UserAPIAccountChangePasswordHandler user_api.AccountChangePasswordHandler
// UserAPIAddBucketLifecycleHandler sets the operation handler for the add bucket lifecycle operation
UserAPIAddBucketLifecycleHandler user_api.AddBucketLifecycleHandler
// AdminAPIAddGroupHandler sets the operation handler for the add group operation
AdminAPIAddGroupHandler admin_api.AddGroupHandler
// AdminAPIAddNotificationEndpointHandler sets the operation handler for the add notification endpoint operation
AdminAPIAddNotificationEndpointHandler admin_api.AddNotificationEndpointHandler
// AdminAPIAddPolicyHandler sets the operation handler for the add policy operation
AdminAPIAddPolicyHandler admin_api.AddPolicyHandler
// UserAPIAddRemoteBucketHandler sets the operation handler for the add remote bucket operation
UserAPIAddRemoteBucketHandler user_api.AddRemoteBucketHandler
// AdminAPIAddTierHandler sets the operation handler for the add tier operation
AdminAPIAddTierHandler admin_api.AddTierHandler
// AdminAPIAddUserHandler sets the operation handler for the add user operation
AdminAPIAddUserHandler admin_api.AddUserHandler
// AdminAPIAdminInfoHandler sets the operation handler for the admin info operation
AdminAPIAdminInfoHandler admin_api.AdminInfoHandler
// AdminAPIArnListHandler sets the operation handler for the arn list operation
AdminAPIArnListHandler admin_api.ArnListHandler
// UserAPIBucketInfoHandler sets the operation handler for the bucket info operation
UserAPIBucketInfoHandler user_api.BucketInfoHandler
// UserAPIBucketSetPolicyHandler sets the operation handler for the bucket set policy operation
UserAPIBucketSetPolicyHandler user_api.BucketSetPolicyHandler
// AdminAPIBulkUpdateUsersGroupsHandler sets the operation handler for the bulk update users groups operation
AdminAPIBulkUpdateUsersGroupsHandler admin_api.BulkUpdateUsersGroupsHandler
// AdminAPIChangeUserPasswordHandler sets the operation handler for the change user password operation
AdminAPIChangeUserPasswordHandler admin_api.ChangeUserPasswordHandler
// AdminAPIConfigInfoHandler sets the operation handler for the config info operation
AdminAPIConfigInfoHandler admin_api.ConfigInfoHandler
// AdminAPICreateAUserServiceAccountHandler sets the operation handler for the create a user service account operation
AdminAPICreateAUserServiceAccountHandler admin_api.CreateAUserServiceAccountHandler
// UserAPICreateBucketEventHandler sets the operation handler for the create bucket event operation
UserAPICreateBucketEventHandler user_api.CreateBucketEventHandler
// UserAPICreateServiceAccountHandler sets the operation handler for the create service account operation
UserAPICreateServiceAccountHandler user_api.CreateServiceAccountHandler
// AdminAPICreateServiceAccountCredentialsHandler sets the operation handler for the create service account credentials operation
AdminAPICreateServiceAccountCredentialsHandler admin_api.CreateServiceAccountCredentialsHandler
// AdminAPICreateServiceAccountCredsHandler sets the operation handler for the create service account creds operation
AdminAPICreateServiceAccountCredsHandler admin_api.CreateServiceAccountCredsHandler
// AdminAPIDashboardWidgetDetailsHandler sets the operation handler for the dashboard widget details operation
AdminAPIDashboardWidgetDetailsHandler admin_api.DashboardWidgetDetailsHandler
// AdminAPIDeleteAccessRuleWithBucketHandler sets the operation handler for the delete access rule with bucket operation
AdminAPIDeleteAccessRuleWithBucketHandler admin_api.DeleteAccessRuleWithBucketHandler
// UserAPIDeleteBucketHandler sets the operation handler for the delete bucket operation
UserAPIDeleteBucketHandler user_api.DeleteBucketHandler
// UserAPIDeleteBucketEventHandler sets the operation handler for the delete bucket event operation
UserAPIDeleteBucketEventHandler user_api.DeleteBucketEventHandler
// UserAPIDeleteBucketReplicationRuleHandler sets the operation handler for the delete bucket replication rule operation
UserAPIDeleteBucketReplicationRuleHandler user_api.DeleteBucketReplicationRuleHandler
// UserAPIDeleteMultipleObjectsHandler sets the operation handler for the delete multiple objects operation
UserAPIDeleteMultipleObjectsHandler user_api.DeleteMultipleObjectsHandler
// UserAPIDeleteObjectHandler sets the operation handler for the delete object operation
UserAPIDeleteObjectHandler user_api.DeleteObjectHandler
// UserAPIDeleteObjectRetentionHandler sets the operation handler for the delete object retention operation
UserAPIDeleteObjectRetentionHandler user_api.DeleteObjectRetentionHandler
// UserAPIDeleteRemoteBucketHandler sets the operation handler for the delete remote bucket operation
UserAPIDeleteRemoteBucketHandler user_api.DeleteRemoteBucketHandler
// UserAPIDeleteServiceAccountHandler sets the operation handler for the delete service account operation
UserAPIDeleteServiceAccountHandler user_api.DeleteServiceAccountHandler
// UserAPIDisableBucketEncryptionHandler sets the operation handler for the disable bucket encryption operation
UserAPIDisableBucketEncryptionHandler user_api.DisableBucketEncryptionHandler
// UserAPIDownloadObjectHandler sets the operation handler for the download object operation
UserAPIDownloadObjectHandler user_api.DownloadObjectHandler
// AdminAPIEditTierCredentialsHandler sets the operation handler for the edit tier credentials operation
AdminAPIEditTierCredentialsHandler admin_api.EditTierCredentialsHandler
// UserAPIEnableBucketEncryptionHandler sets the operation handler for the enable bucket encryption operation
UserAPIEnableBucketEncryptionHandler user_api.EnableBucketEncryptionHandler
// UserAPIGetBucketEncryptionInfoHandler sets the operation handler for the get bucket encryption info operation
UserAPIGetBucketEncryptionInfoHandler user_api.GetBucketEncryptionInfoHandler
// UserAPIGetBucketLifecycleHandler sets the operation handler for the get bucket lifecycle operation
UserAPIGetBucketLifecycleHandler user_api.GetBucketLifecycleHandler
// UserAPIGetBucketObjectLockingStatusHandler sets the operation handler for the get bucket object locking status operation
UserAPIGetBucketObjectLockingStatusHandler user_api.GetBucketObjectLockingStatusHandler
// UserAPIGetBucketQuotaHandler sets the operation handler for the get bucket quota operation
UserAPIGetBucketQuotaHandler user_api.GetBucketQuotaHandler
// UserAPIGetBucketReplicationHandler sets the operation handler for the get bucket replication operation
UserAPIGetBucketReplicationHandler user_api.GetBucketReplicationHandler
// UserAPIGetBucketRetentionConfigHandler sets the operation handler for the get bucket retention config operation
UserAPIGetBucketRetentionConfigHandler user_api.GetBucketRetentionConfigHandler
// UserAPIGetBucketRewindHandler sets the operation handler for the get bucket rewind operation
UserAPIGetBucketRewindHandler user_api.GetBucketRewindHandler
// UserAPIGetBucketVersioningHandler sets the operation handler for the get bucket versioning operation
UserAPIGetBucketVersioningHandler user_api.GetBucketVersioningHandler
// AdminAPIGetTierHandler sets the operation handler for the get tier operation
AdminAPIGetTierHandler admin_api.GetTierHandler
// AdminAPIGetUserInfoHandler sets the operation handler for the get user info operation
AdminAPIGetUserInfoHandler admin_api.GetUserInfoHandler
// AdminAPIGroupInfoHandler sets the operation handler for the group info operation
AdminAPIGroupInfoHandler admin_api.GroupInfoHandler
// UserAPIHasPermissionToHandler sets the operation handler for the has permission to operation
UserAPIHasPermissionToHandler user_api.HasPermissionToHandler
// AdminAPIListAUserServiceAccountsHandler sets the operation handler for the list a user service accounts operation
AdminAPIListAUserServiceAccountsHandler admin_api.ListAUserServiceAccountsHandler
// AdminAPIListAccessRulesWithBucketHandler sets the operation handler for the list access rules with bucket operation
AdminAPIListAccessRulesWithBucketHandler admin_api.ListAccessRulesWithBucketHandler
// UserAPIListBucketEventsHandler sets the operation handler for the list bucket events operation
UserAPIListBucketEventsHandler user_api.ListBucketEventsHandler
// UserAPIListBucketsHandler sets the operation handler for the list buckets operation
UserAPIListBucketsHandler user_api.ListBucketsHandler
// AdminAPIListConfigHandler sets the operation handler for the list config operation
AdminAPIListConfigHandler admin_api.ListConfigHandler
// UserAPIListExternalBucketsHandler sets the operation handler for the list external buckets operation
UserAPIListExternalBucketsHandler user_api.ListExternalBucketsHandler
// AdminAPIListGroupsHandler sets the operation handler for the list groups operation
AdminAPIListGroupsHandler admin_api.ListGroupsHandler
// AdminAPIListGroupsForPolicyHandler sets the operation handler for the list groups for policy operation
AdminAPIListGroupsForPolicyHandler admin_api.ListGroupsForPolicyHandler
// UserAPIListObjectsHandler sets the operation handler for the list objects operation
UserAPIListObjectsHandler user_api.ListObjectsHandler
// AdminAPIListPoliciesHandler sets the operation handler for the list policies operation
AdminAPIListPoliciesHandler admin_api.ListPoliciesHandler
// AdminAPIListPoliciesWithBucketHandler sets the operation handler for the list policies with bucket operation
AdminAPIListPoliciesWithBucketHandler admin_api.ListPoliciesWithBucketHandler
// UserAPIListRemoteBucketsHandler sets the operation handler for the list remote buckets operation
UserAPIListRemoteBucketsHandler user_api.ListRemoteBucketsHandler
// UserAPIListUserServiceAccountsHandler sets the operation handler for the list user service accounts operation
UserAPIListUserServiceAccountsHandler user_api.ListUserServiceAccountsHandler
// AdminAPIListUsersHandler sets the operation handler for the list users operation
AdminAPIListUsersHandler admin_api.ListUsersHandler
// AdminAPIListUsersForPolicyHandler sets the operation handler for the list users for policy operation
AdminAPIListUsersForPolicyHandler admin_api.ListUsersForPolicyHandler
// AdminAPIListUsersWithAccessToBucketHandler sets the operation handler for the list users with access to bucket operation
AdminAPIListUsersWithAccessToBucketHandler admin_api.ListUsersWithAccessToBucketHandler
// UserAPILogSearchHandler sets the operation handler for the log search operation
UserAPILogSearchHandler user_api.LogSearchHandler
// UserAPILoginHandler sets the operation handler for the login operation
UserAPILoginHandler user_api.LoginHandler
// UserAPILoginDetailHandler sets the operation handler for the login detail operation
UserAPILoginDetailHandler user_api.LoginDetailHandler
// UserAPILoginOauth2AuthHandler sets the operation handler for the login oauth2 auth operation
UserAPILoginOauth2AuthHandler user_api.LoginOauth2AuthHandler
// UserAPILoginOperatorHandler sets the operation handler for the login operator operation
UserAPILoginOperatorHandler user_api.LoginOperatorHandler
// UserAPILogoutHandler sets the operation handler for the logout operation
UserAPILogoutHandler user_api.LogoutHandler
// UserAPIMakeBucketHandler sets the operation handler for the make bucket operation
UserAPIMakeBucketHandler user_api.MakeBucketHandler
// AdminAPINotificationEndpointListHandler sets the operation handler for the notification endpoint list operation
AdminAPINotificationEndpointListHandler admin_api.NotificationEndpointListHandler
// AdminAPIPolicyInfoHandler sets the operation handler for the policy info operation
AdminAPIPolicyInfoHandler admin_api.PolicyInfoHandler
// UserAPIPostBucketsBucketNameObjectsUploadHandler sets the operation handler for the post buckets bucket name objects upload operation
UserAPIPostBucketsBucketNameObjectsUploadHandler user_api.PostBucketsBucketNameObjectsUploadHandler
// AdminAPIProfilingStartHandler sets the operation handler for the profiling start operation
AdminAPIProfilingStartHandler admin_api.ProfilingStartHandler
// AdminAPIProfilingStopHandler sets the operation handler for the profiling stop operation
AdminAPIProfilingStopHandler admin_api.ProfilingStopHandler
// UserAPIPutObjectLegalHoldHandler sets the operation handler for the put object legal hold operation
UserAPIPutObjectLegalHoldHandler user_api.PutObjectLegalHoldHandler
// UserAPIPutObjectRetentionHandler sets the operation handler for the put object retention operation
UserAPIPutObjectRetentionHandler user_api.PutObjectRetentionHandler
// UserAPIPutObjectTagsHandler sets the operation handler for the put object tags operation
UserAPIPutObjectTagsHandler user_api.PutObjectTagsHandler
// UserAPIRemoteBucketDetailsHandler sets the operation handler for the remote bucket details operation
UserAPIRemoteBucketDetailsHandler user_api.RemoteBucketDetailsHandler
// AdminAPIRemoveGroupHandler sets the operation handler for the remove group operation
AdminAPIRemoveGroupHandler admin_api.RemoveGroupHandler
// AdminAPIRemovePolicyHandler sets the operation handler for the remove policy operation
AdminAPIRemovePolicyHandler admin_api.RemovePolicyHandler
// AdminAPIRemoveUserHandler sets the operation handler for the remove user operation
AdminAPIRemoveUserHandler admin_api.RemoveUserHandler
// AdminAPIRestartServiceHandler sets the operation handler for the restart service operation
AdminAPIRestartServiceHandler admin_api.RestartServiceHandler
// UserAPISessionCheckHandler sets the operation handler for the session check operation
UserAPISessionCheckHandler user_api.SessionCheckHandler
// AdminAPISetAccessRuleWithBucketHandler sets the operation handler for the set access rule with bucket operation
AdminAPISetAccessRuleWithBucketHandler admin_api.SetAccessRuleWithBucketHandler
// UserAPISetBucketQuotaHandler sets the operation handler for the set bucket quota operation
UserAPISetBucketQuotaHandler user_api.SetBucketQuotaHandler
// UserAPISetBucketRetentionConfigHandler sets the operation handler for the set bucket retention config operation
UserAPISetBucketRetentionConfigHandler user_api.SetBucketRetentionConfigHandler
// UserAPISetBucketVersioningHandler sets the operation handler for the set bucket versioning operation
UserAPISetBucketVersioningHandler user_api.SetBucketVersioningHandler
// AdminAPISetConfigHandler sets the operation handler for the set config operation
AdminAPISetConfigHandler admin_api.SetConfigHandler
// UserAPISetMultiBucketReplicationHandler sets the operation handler for the set multi bucket replication operation
UserAPISetMultiBucketReplicationHandler user_api.SetMultiBucketReplicationHandler
// AdminAPISetPolicyHandler sets the operation handler for the set policy operation
AdminAPISetPolicyHandler admin_api.SetPolicyHandler
// AdminAPISetPolicyMultipleHandler sets the operation handler for the set policy multiple operation
AdminAPISetPolicyMultipleHandler admin_api.SetPolicyMultipleHandler
UserAPIShareObjectHandler user_api.ShareObjectHandler
// AdminAPISubscriptionInfoHandler sets the operation handler for the subscription info operation
AdminAPISubscriptionInfoHandler admin_api.SubscriptionInfoHandler
// AdminAPITiersListHandler sets the operation handler for the tiers list operation
AdminAPITiersListHandler admin_api.TiersListHandler
// UserAPIUpdateBucketLifecycleHandler sets the operation handler for the update bucket lifecycle operation
UserAPIUpdateBucketLifecycleHandler user_api.UpdateBucketLifecycleHandler
// AdminAPIUpdateGroupHandler sets the operation handler for the update group operation
AdminAPIUpdateGroupHandler admin_api.UpdateGroupHandler
// AdminAPIUpdateUserGroupsHandler sets the operation handler for the update user groups operation
AdminAPIUpdateUserGroupsHandler admin_api.UpdateUserGroupsHandler
// AdminAPIUpdateUserInfoHandler sets the operation handler for the update user info operation
AdminAPIUpdateUserInfoHandler admin_api.UpdateUserInfoHandler
// 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
}
ConsoleAPI the console API
func NewConsoleAPI ¶
func NewConsoleAPI(spec *loads.Document) *ConsoleAPI
NewConsoleAPI creates a new Console instance
func (*ConsoleAPI) AddMiddlewareFor ¶
func (o *ConsoleAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*ConsoleAPI) AuthenticatorsFor ¶
func (o *ConsoleAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*ConsoleAPI) Authorizer ¶
func (o *ConsoleAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*ConsoleAPI) ConsumersFor ¶
func (o *ConsoleAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*ConsoleAPI) Context ¶
func (o *ConsoleAPI) Context() *middleware.Context
Context returns the middleware context for the console API
func (*ConsoleAPI) DefaultConsumes ¶
func (o *ConsoleAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*ConsoleAPI) DefaultProduces ¶
func (o *ConsoleAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*ConsoleAPI) Formats ¶
func (o *ConsoleAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*ConsoleAPI) HandlerFor ¶
func (o *ConsoleAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*ConsoleAPI) Init ¶
func (o *ConsoleAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*ConsoleAPI) ProducersFor ¶
func (o *ConsoleAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*ConsoleAPI) RegisterConsumer ¶
func (o *ConsoleAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*ConsoleAPI) RegisterFormat ¶
RegisterFormat registers a custom format validator
func (*ConsoleAPI) RegisterProducer ¶
func (o *ConsoleAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*ConsoleAPI) Serve ¶
func (o *ConsoleAPI) 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 (*ConsoleAPI) ServeErrorFor ¶
func (o *ConsoleAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*ConsoleAPI) SetDefaultConsumes ¶
func (o *ConsoleAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*ConsoleAPI) SetDefaultProduces ¶
func (o *ConsoleAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*ConsoleAPI) SetSpec ¶
func (o *ConsoleAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*ConsoleAPI) UseRedoc ¶ added in v0.7.5
func (o *ConsoleAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*ConsoleAPI) UseSwaggerUI ¶ added in v0.7.5
func (o *ConsoleAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*ConsoleAPI) Validate ¶
func (o *ConsoleAPI) Validate() error
Validate validates the registrations in the ConsoleAPI