Documentation
¶
Index ¶
- type AndromedaAPI
- func (o *AndromedaAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
- func (o *AndromedaAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
- func (o *AndromedaAPI) Authorizer() runtime.Authorizer
- func (o *AndromedaAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
- func (o *AndromedaAPI) Context() *middleware.Context
- func (o *AndromedaAPI) DefaultConsumes() string
- func (o *AndromedaAPI) DefaultProduces() string
- func (o *AndromedaAPI) Formats() strfmt.Registry
- func (o *AndromedaAPI) HandlerFor(method, path string) (http.Handler, bool)
- func (o *AndromedaAPI) Init()
- func (o *AndromedaAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
- func (o *AndromedaAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
- func (o *AndromedaAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
- func (o *AndromedaAPI) RegisterProducer(mediaType string, producer runtime.Producer)
- func (o *AndromedaAPI) Serve(builder middleware.Builder) http.Handler
- func (o *AndromedaAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
- func (o *AndromedaAPI) SetDefaultConsumes(mediaType string)
- func (o *AndromedaAPI) SetDefaultProduces(mediaType string)
- func (o *AndromedaAPI) SetSpec(spec *loads.Document)
- func (o *AndromedaAPI) UseRedoc()
- func (o *AndromedaAPI) UseSwaggerUI()
- func (o *AndromedaAPI) Validate() error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AndromedaAPI ¶
type AndromedaAPI 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
// DatacentersDeleteDatacentersDatacenterIDHandler sets the operation handler for the delete datacenters datacenter ID operation
DatacentersDeleteDatacentersDatacenterIDHandler datacenters.DeleteDatacentersDatacenterIDHandler
// DomainsDeleteDomainsDomainIDHandler sets the operation handler for the delete domains domain ID operation
DomainsDeleteDomainsDomainIDHandler domains.DeleteDomainsDomainIDHandler
// GeographicMapsDeleteGeomapsGeomapIDHandler sets the operation handler for the delete geomaps geomap ID operation
GeographicMapsDeleteGeomapsGeomapIDHandler geographic_maps.DeleteGeomapsGeomapIDHandler
// MembersDeleteMembersMemberIDHandler sets the operation handler for the delete members member ID operation
MembersDeleteMembersMemberIDHandler members.DeleteMembersMemberIDHandler
// MonitorsDeleteMonitorsMonitorIDHandler sets the operation handler for the delete monitors monitor ID operation
MonitorsDeleteMonitorsMonitorIDHandler monitors.DeleteMonitorsMonitorIDHandler
// PoolsDeletePoolsPoolIDHandler sets the operation handler for the delete pools pool ID operation
PoolsDeletePoolsPoolIDHandler pools.DeletePoolsPoolIDHandler
// AdministrativeDeleteQuotasProjectIDHandler sets the operation handler for the delete quotas project ID operation
AdministrativeDeleteQuotasProjectIDHandler administrative.DeleteQuotasProjectIDHandler
// DatacentersGetDatacentersHandler sets the operation handler for the get datacenters operation
DatacentersGetDatacentersHandler datacenters.GetDatacentersHandler
// DatacentersGetDatacentersDatacenterIDHandler sets the operation handler for the get datacenters datacenter ID operation
DatacentersGetDatacentersDatacenterIDHandler datacenters.GetDatacentersDatacenterIDHandler
// DomainsGetDomainsHandler sets the operation handler for the get domains operation
DomainsGetDomainsHandler domains.GetDomainsHandler
// DomainsGetDomainsDomainIDHandler sets the operation handler for the get domains domain ID operation
DomainsGetDomainsDomainIDHandler domains.GetDomainsDomainIDHandler
// GeographicMapsGetGeomapsHandler sets the operation handler for the get geomaps operation
GeographicMapsGetGeomapsHandler geographic_maps.GetGeomapsHandler
// GeographicMapsGetGeomapsGeomapIDHandler sets the operation handler for the get geomaps geomap ID operation
GeographicMapsGetGeomapsGeomapIDHandler geographic_maps.GetGeomapsGeomapIDHandler
// MembersGetMembersHandler sets the operation handler for the get members operation
MembersGetMembersHandler members.GetMembersHandler
// MembersGetMembersMemberIDHandler sets the operation handler for the get members member ID operation
MembersGetMembersMemberIDHandler members.GetMembersMemberIDHandler
// MonitorsGetMonitorsHandler sets the operation handler for the get monitors operation
MonitorsGetMonitorsHandler monitors.GetMonitorsHandler
// MonitorsGetMonitorsMonitorIDHandler sets the operation handler for the get monitors monitor ID operation
MonitorsGetMonitorsMonitorIDHandler monitors.GetMonitorsMonitorIDHandler
// PoolsGetPoolsHandler sets the operation handler for the get pools operation
PoolsGetPoolsHandler pools.GetPoolsHandler
// PoolsGetPoolsPoolIDHandler sets the operation handler for the get pools pool ID operation
PoolsGetPoolsPoolIDHandler pools.GetPoolsPoolIDHandler
// AdministrativeGetQuotasHandler sets the operation handler for the get quotas operation
AdministrativeGetQuotasHandler administrative.GetQuotasHandler
// AdministrativeGetQuotasDefaultsHandler sets the operation handler for the get quotas defaults operation
AdministrativeGetQuotasDefaultsHandler administrative.GetQuotasDefaultsHandler
// AdministrativeGetQuotasProjectIDHandler sets the operation handler for the get quotas project ID operation
AdministrativeGetQuotasProjectIDHandler administrative.GetQuotasProjectIDHandler
// AdministrativeGetServicesHandler sets the operation handler for the get services operation
AdministrativeGetServicesHandler administrative.GetServicesHandler
// DatacentersPostDatacentersHandler sets the operation handler for the post datacenters operation
DatacentersPostDatacentersHandler datacenters.PostDatacentersHandler
// DomainsPostDomainsHandler sets the operation handler for the post domains operation
DomainsPostDomainsHandler domains.PostDomainsHandler
// GeographicMapsPostGeomapsHandler sets the operation handler for the post geomaps operation
GeographicMapsPostGeomapsHandler geographic_maps.PostGeomapsHandler
// MembersPostMembersHandler sets the operation handler for the post members operation
MembersPostMembersHandler members.PostMembersHandler
// MonitorsPostMonitorsHandler sets the operation handler for the post monitors operation
MonitorsPostMonitorsHandler monitors.PostMonitorsHandler
// PoolsPostPoolsHandler sets the operation handler for the post pools operation
PoolsPostPoolsHandler pools.PostPoolsHandler
// AdministrativePostSyncHandler sets the operation handler for the post sync operation
AdministrativePostSyncHandler administrative.PostSyncHandler
// DatacentersPutDatacentersDatacenterIDHandler sets the operation handler for the put datacenters datacenter ID operation
DatacentersPutDatacentersDatacenterIDHandler datacenters.PutDatacentersDatacenterIDHandler
// DomainsPutDomainsDomainIDHandler sets the operation handler for the put domains domain ID operation
DomainsPutDomainsDomainIDHandler domains.PutDomainsDomainIDHandler
// GeographicMapsPutGeomapsGeomapIDHandler sets the operation handler for the put geomaps geomap ID operation
GeographicMapsPutGeomapsGeomapIDHandler geographic_maps.PutGeomapsGeomapIDHandler
// MembersPutMembersMemberIDHandler sets the operation handler for the put members member ID operation
MembersPutMembersMemberIDHandler members.PutMembersMemberIDHandler
// MonitorsPutMonitorsMonitorIDHandler sets the operation handler for the put monitors monitor ID operation
MonitorsPutMonitorsMonitorIDHandler monitors.PutMonitorsMonitorIDHandler
// PoolsPutPoolsPoolIDHandler sets the operation handler for the put pools pool ID operation
PoolsPutPoolsPoolIDHandler pools.PutPoolsPoolIDHandler
// AdministrativePutQuotasProjectIDHandler sets the operation handler for the put quotas project ID operation
AdministrativePutQuotasProjectIDHandler administrative.PutQuotasProjectIDHandler
// 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
}
AndromedaAPI Platform agnostic GSLB frontend
func NewAndromedaAPI ¶
func NewAndromedaAPI(spec *loads.Document) *AndromedaAPI
NewAndromedaAPI creates a new Andromeda instance
func (*AndromedaAPI) AddMiddlewareFor ¶
func (o *AndromedaAPI) AddMiddlewareFor(method, path string, builder middleware.Builder)
AddMiddlewareFor adds a http middleware to existing handler
func (*AndromedaAPI) AuthenticatorsFor ¶
func (o *AndromedaAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
AuthenticatorsFor gets the authenticators for the specified security schemes
func (*AndromedaAPI) Authorizer ¶
func (o *AndromedaAPI) Authorizer() runtime.Authorizer
Authorizer returns the registered authorizer
func (*AndromedaAPI) ConsumersFor ¶
func (o *AndromedaAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
ConsumersFor gets the consumers for the specified media types. MIME type parameters are ignored here.
func (*AndromedaAPI) Context ¶
func (o *AndromedaAPI) Context() *middleware.Context
Context returns the middleware context for the andromeda API
func (*AndromedaAPI) DefaultConsumes ¶
func (o *AndromedaAPI) DefaultConsumes() string
DefaultConsumes returns the default consumes media type
func (*AndromedaAPI) DefaultProduces ¶
func (o *AndromedaAPI) DefaultProduces() string
DefaultProduces returns the default produces media type
func (*AndromedaAPI) Formats ¶
func (o *AndromedaAPI) Formats() strfmt.Registry
Formats returns the registered string formats
func (*AndromedaAPI) HandlerFor ¶
func (o *AndromedaAPI) HandlerFor(method, path string) (http.Handler, bool)
HandlerFor gets a http.Handler for the provided operation method and path
func (*AndromedaAPI) Init ¶
func (o *AndromedaAPI) Init()
Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit
func (*AndromedaAPI) ProducersFor ¶
func (o *AndromedaAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
ProducersFor gets the producers for the specified media types. MIME type parameters are ignored here.
func (*AndromedaAPI) RegisterConsumer ¶
func (o *AndromedaAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
RegisterConsumer allows you to add (or override) a consumer for a media type.
func (*AndromedaAPI) RegisterFormat ¶
func (o *AndromedaAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
RegisterFormat registers a custom format validator
func (*AndromedaAPI) RegisterProducer ¶
func (o *AndromedaAPI) RegisterProducer(mediaType string, producer runtime.Producer)
RegisterProducer allows you to add (or override) a producer for a media type.
func (*AndromedaAPI) Serve ¶
func (o *AndromedaAPI) 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 (*AndromedaAPI) ServeErrorFor ¶
func (o *AndromedaAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
ServeErrorFor gets a error handler for a given operation id
func (*AndromedaAPI) SetDefaultConsumes ¶
func (o *AndromedaAPI) SetDefaultConsumes(mediaType string)
SetDefaultConsumes returns the default consumes media type
func (*AndromedaAPI) SetDefaultProduces ¶
func (o *AndromedaAPI) SetDefaultProduces(mediaType string)
SetDefaultProduces sets the default produces media type
func (*AndromedaAPI) SetSpec ¶
func (o *AndromedaAPI) SetSpec(spec *loads.Document)
SetSpec sets a spec that will be served for the clients.
func (*AndromedaAPI) UseRedoc ¶
func (o *AndromedaAPI) UseRedoc()
UseRedoc for documentation at /docs
func (*AndromedaAPI) UseSwaggerUI ¶
func (o *AndromedaAPI) UseSwaggerUI()
UseSwaggerUI for documentation at /docs
func (*AndromedaAPI) Validate ¶
func (o *AndromedaAPI) Validate() error
Validate validates the registrations in the AndromedaAPI