operations

Documentation

Index

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

Types

type AssistedInstallAPI

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

	// 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

	// InstallerCancelInstallationHandler sets the operation handler for the cancel installation operation
	InstallerCancelInstallationHandler installer.CancelInstallationHandler
	// InstallerCompleteInstallationHandler sets the operation handler for the complete installation operation
	InstallerCompleteInstallationHandler installer.CompleteInstallationHandler
	// InstallerDeregisterClusterHandler sets the operation handler for the deregister cluster operation
	InstallerDeregisterClusterHandler installer.DeregisterClusterHandler
	// InstallerDeregisterHostHandler sets the operation handler for the deregister host operation
	InstallerDeregisterHostHandler installer.DeregisterHostHandler
	// InstallerDisableHostHandler sets the operation handler for the disable host operation
	InstallerDisableHostHandler installer.DisableHostHandler
	// InstallerDownloadClusterFilesHandler sets the operation handler for the download cluster files operation
	InstallerDownloadClusterFilesHandler installer.DownloadClusterFilesHandler
	// InstallerDownloadClusterISOHandler sets the operation handler for the download cluster i s o operation
	InstallerDownloadClusterISOHandler installer.DownloadClusterISOHandler
	// InstallerDownloadClusterKubeconfigHandler sets the operation handler for the download cluster kubeconfig operation
	InstallerDownloadClusterKubeconfigHandler installer.DownloadClusterKubeconfigHandler
	// InstallerEnableHostHandler sets the operation handler for the enable host operation
	InstallerEnableHostHandler installer.EnableHostHandler
	// InstallerGenerateClusterISOHandler sets the operation handler for the generate cluster i s o operation
	InstallerGenerateClusterISOHandler installer.GenerateClusterISOHandler
	// InstallerGetClusterHandler sets the operation handler for the get cluster operation
	InstallerGetClusterHandler installer.GetClusterHandler
	// InstallerGetCredentialsHandler sets the operation handler for the get credentials operation
	InstallerGetCredentialsHandler installer.GetCredentialsHandler
	// InstallerGetFreeAddressesHandler sets the operation handler for the get free addresses operation
	InstallerGetFreeAddressesHandler installer.GetFreeAddressesHandler
	// InstallerGetHostHandler sets the operation handler for the get host operation
	InstallerGetHostHandler installer.GetHostHandler
	// InstallerGetNextStepsHandler sets the operation handler for the get next steps operation
	InstallerGetNextStepsHandler installer.GetNextStepsHandler
	// InstallerInstallClusterHandler sets the operation handler for the install cluster operation
	InstallerInstallClusterHandler installer.InstallClusterHandler
	// InstallerListClustersHandler sets the operation handler for the list clusters operation
	InstallerListClustersHandler installer.ListClustersHandler
	// VersionsListComponentVersionsHandler sets the operation handler for the list component versions operation
	VersionsListComponentVersionsHandler versions.ListComponentVersionsHandler
	// EventsListEventsHandler sets the operation handler for the list events operation
	EventsListEventsHandler events.ListEventsHandler
	// InstallerListHostsHandler sets the operation handler for the list hosts operation
	InstallerListHostsHandler installer.ListHostsHandler
	// ManagedDomainsListManagedDomainsHandler sets the operation handler for the list managed domains operation
	ManagedDomainsListManagedDomainsHandler managed_domains.ListManagedDomainsHandler
	// InstallerPostStepReplyHandler sets the operation handler for the post step reply operation
	InstallerPostStepReplyHandler installer.PostStepReplyHandler
	// InstallerRegisterClusterHandler sets the operation handler for the register cluster operation
	InstallerRegisterClusterHandler installer.RegisterClusterHandler
	// InstallerRegisterHostHandler sets the operation handler for the register host operation
	InstallerRegisterHostHandler installer.RegisterHostHandler
	// InstallerResetClusterHandler sets the operation handler for the reset cluster operation
	InstallerResetClusterHandler installer.ResetClusterHandler
	// InstallerSetDebugStepHandler sets the operation handler for the set debug step operation
	InstallerSetDebugStepHandler installer.SetDebugStepHandler
	// InstallerUpdateClusterHandler sets the operation handler for the update cluster operation
	InstallerUpdateClusterHandler installer.UpdateClusterHandler
	// InstallerUpdateHostInstallProgressHandler sets the operation handler for the update host install progress operation
	InstallerUpdateHostInstallProgressHandler installer.UpdateHostInstallProgressHandler
	// InstallerUploadClusterIngressCertHandler sets the operation handler for the upload cluster ingress cert operation
	InstallerUploadClusterIngressCertHandler installer.UploadClusterIngressCertHandler
	// 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
}

AssistedInstallAPI Assisted installation

func NewAssistedInstallAPI

func NewAssistedInstallAPI(spec *loads.Document) *AssistedInstallAPI

NewAssistedInstallAPI creates a new AssistedInstall instance

func (*AssistedInstallAPI) AddMiddlewareFor

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

AddMiddlewareFor adds a http middleware to existing handler

func (*AssistedInstallAPI) AuthenticatorsFor

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*AssistedInstallAPI) Authorizer

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

Authorizer returns the registered authorizer

func (*AssistedInstallAPI) ConsumersFor

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

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

func (*AssistedInstallAPI) Context

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

Context returns the middleware context for the assisted install API

func (*AssistedInstallAPI) DefaultConsumes

func (o *AssistedInstallAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*AssistedInstallAPI) DefaultProduces

func (o *AssistedInstallAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*AssistedInstallAPI) Formats

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

Formats returns the registered string formats

func (*AssistedInstallAPI) HandlerFor

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

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

func (*AssistedInstallAPI) Init

func (o *AssistedInstallAPI) Init()

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

func (*AssistedInstallAPI) ProducersFor

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

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

func (*AssistedInstallAPI) RegisterConsumer

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

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

func (*AssistedInstallAPI) RegisterFormat

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

RegisterFormat registers a custom format validator

func (*AssistedInstallAPI) RegisterProducer

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

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

func (*AssistedInstallAPI) Serve

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

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

ServeErrorFor gets a error handler for a given operation id

func (*AssistedInstallAPI) SetDefaultConsumes

func (o *AssistedInstallAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*AssistedInstallAPI) SetDefaultProduces

func (o *AssistedInstallAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*AssistedInstallAPI) SetSpec

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

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

func (*AssistedInstallAPI) Validate

func (o *AssistedInstallAPI) Validate() error

Validate validates the registrations in the AssistedInstallAPI