operations

package
v0.0.0-...-c66050e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 2, 2020 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const CheckAllPodsOKCode int = 200

CheckAllPodsOKCode is the HTTP code returned for type CheckAllPodsOK

View Source 
const CheckServicePodsOKCode int = 200

CheckServicePodsOKCode is the HTTP code returned for type CheckServicePodsOK

View Source 
const HealthzOKCode int = 200

HealthzOKCode is the HTTP code returned for type HealthzOK

View Source 
const HealthzServiceUnavailableCode int = 503

HealthzServiceUnavailableCode is the HTTP code returned for type HealthzServiceUnavailable

View Source 
const PingOKCode int = 200

PingOKCode is the HTTP code returned for type PingOK

Variables

This section is empty.

Functions

This section is empty.

Types

type CheckAllPods 

type CheckAllPods struct {
	Context *middleware.Context
	Handler CheckAllPodsHandler
}

CheckAllPods swagger:route GET /check_all checkAllPods

Queries the API server for all other pods in this service, and makes all of them query all of their neighbours, using their pods IPs. Calls their /check endpoint.

func NewCheckAllPods 

func NewCheckAllPods(ctx *middleware.Context, handler CheckAllPodsHandler) *CheckAllPods

NewCheckAllPods creates a new http.Handler for the check all pods operation

func (*CheckAllPods) ServeHTTP 

func (o *CheckAllPods) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CheckAllPodsHandler 

type CheckAllPodsHandler interface {
	Handle(CheckAllPodsParams) middleware.Responder
}

CheckAllPodsHandler interface for that can handle valid check all pods params

type CheckAllPodsHandlerFunc 

type CheckAllPodsHandlerFunc func(CheckAllPodsParams) middleware.Responder

CheckAllPodsHandlerFunc turns a function with the right signature into a check all pods handler

func (CheckAllPodsHandlerFunc) Handle 

func (fn CheckAllPodsHandlerFunc) Handle(params CheckAllPodsParams) middleware.Responder

Handle executing the request and returning a response

type CheckAllPodsOK 

type CheckAllPodsOK struct {

	/*
	  In: Body
	*/
	Payload *models.CheckAllResults `json:"body,omitempty"`
}

CheckAllPodsOK Success, return response

swagger:response checkAllPodsOK

func NewCheckAllPodsOK 

func NewCheckAllPodsOK() *CheckAllPodsOK

NewCheckAllPodsOK creates CheckAllPodsOK with default headers values

func (*CheckAllPodsOK) SetPayload 

func (o *CheckAllPodsOK) SetPayload(payload *models.CheckAllResults)

SetPayload sets the payload to the check all pods o k response

func (*CheckAllPodsOK) WithPayload 

func (o *CheckAllPodsOK) WithPayload(payload *models.CheckAllResults) *CheckAllPodsOK

WithPayload adds the payload to the check all pods o k response

func (*CheckAllPodsOK) WriteResponse 

func (o *CheckAllPodsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CheckAllPodsParams 

type CheckAllPodsParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

CheckAllPodsParams contains all the bound params for the check all pods operation typically these are obtained from a http.Request

swagger:parameters checkAllPods

func NewCheckAllPodsParams 

func NewCheckAllPodsParams() CheckAllPodsParams

NewCheckAllPodsParams creates a new CheckAllPodsParams object no default values defined in spec.

func (*CheckAllPodsParams) BindRequest 

func (o *CheckAllPodsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewCheckAllPodsParams() beforehand.

type CheckAllPodsURL 

type CheckAllPodsURL struct {
	// contains filtered or unexported fields
}

CheckAllPodsURL generates an URL for the check all pods operation

func (*CheckAllPodsURL) Build 

func (o *CheckAllPodsURL) Build() (*url.URL, error)

Build a url path and query string

func (*CheckAllPodsURL) BuildFull 

func (o *CheckAllPodsURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CheckAllPodsURL) Must 

func (o *CheckAllPodsURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*CheckAllPodsURL) SetBasePath 

func (o *CheckAllPodsURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*CheckAllPodsURL) String 

func (o *CheckAllPodsURL) String() string

String returns the string representation of the path with query string

func (*CheckAllPodsURL) StringFull 

func (o *CheckAllPodsURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CheckAllPodsURL) WithBasePath 

func (o *CheckAllPodsURL) WithBasePath(bp string) *CheckAllPodsURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type CheckServicePods 

type CheckServicePods struct {
	Context *middleware.Context
	Handler CheckServicePodsHandler
}

CheckServicePods swagger:route GET /check checkServicePods

Queries the API server for all other pods in this service, and pings them via their pods IPs. Calls their /ping endpoint

func NewCheckServicePods 

func NewCheckServicePods(ctx *middleware.Context, handler CheckServicePodsHandler) *CheckServicePods

NewCheckServicePods creates a new http.Handler for the check service pods operation

func (*CheckServicePods) ServeHTTP 

func (o *CheckServicePods) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type CheckServicePodsHandler 

type CheckServicePodsHandler interface {
	Handle(CheckServicePodsParams) middleware.Responder
}

CheckServicePodsHandler interface for that can handle valid check service pods params

type CheckServicePodsHandlerFunc 

type CheckServicePodsHandlerFunc func(CheckServicePodsParams) middleware.Responder

CheckServicePodsHandlerFunc turns a function with the right signature into a check service pods handler

func (CheckServicePodsHandlerFunc) Handle 

func (fn CheckServicePodsHandlerFunc) Handle(params CheckServicePodsParams) middleware.Responder

Handle executing the request and returning a response

type CheckServicePodsOK 

type CheckServicePodsOK struct {

	/*
	  In: Body
	*/
	Payload *models.CheckResults `json:"body,omitempty"`
}

CheckServicePodsOK Success, return response

swagger:response checkServicePodsOK

func NewCheckServicePodsOK 

func NewCheckServicePodsOK() *CheckServicePodsOK

NewCheckServicePodsOK creates CheckServicePodsOK with default headers values

func (*CheckServicePodsOK) SetPayload 

func (o *CheckServicePodsOK) SetPayload(payload *models.CheckResults)

SetPayload sets the payload to the check service pods o k response

func (*CheckServicePodsOK) WithPayload 

func (o *CheckServicePodsOK) WithPayload(payload *models.CheckResults) *CheckServicePodsOK

WithPayload adds the payload to the check service pods o k response

func (*CheckServicePodsOK) WriteResponse 

func (o *CheckServicePodsOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type CheckServicePodsParams 

type CheckServicePodsParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

CheckServicePodsParams contains all the bound params for the check service pods operation typically these are obtained from a http.Request

swagger:parameters checkServicePods

func NewCheckServicePodsParams 

func NewCheckServicePodsParams() CheckServicePodsParams

NewCheckServicePodsParams creates a new CheckServicePodsParams object no default values defined in spec.

func (*CheckServicePodsParams) BindRequest 

func (o *CheckServicePodsParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewCheckServicePodsParams() beforehand.

type CheckServicePodsURL 

type CheckServicePodsURL struct {
	// contains filtered or unexported fields
}

CheckServicePodsURL generates an URL for the check service pods operation

func (*CheckServicePodsURL) Build 

func (o *CheckServicePodsURL) Build() (*url.URL, error)

Build a url path and query string

func (*CheckServicePodsURL) BuildFull 

func (o *CheckServicePodsURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*CheckServicePodsURL) Must 

func (o *CheckServicePodsURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*CheckServicePodsURL) SetBasePath 

func (o *CheckServicePodsURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*CheckServicePodsURL) String 

func (o *CheckServicePodsURL) String() string

String returns the string representation of the path with query string

func (*CheckServicePodsURL) StringFull 

func (o *CheckServicePodsURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*CheckServicePodsURL) WithBasePath 

func (o *CheckServicePodsURL) WithBasePath(bp string) *CheckServicePodsURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type GoldpingerAPI 

type GoldpingerAPI 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 a "application/json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/json" mime type
	JSONProducer runtime.Producer

	// CheckAllPodsHandler sets the operation handler for the check all pods operation
	CheckAllPodsHandler CheckAllPodsHandler
	// CheckServicePodsHandler sets the operation handler for the check service pods operation
	CheckServicePodsHandler CheckServicePodsHandler
	// HealthzHandler sets the operation handler for the healthz operation
	HealthzHandler HealthzHandler
	// PingHandler sets the operation handler for the ping operation
	PingHandler PingHandler

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

GoldpingerAPI the goldpinger API

func NewGoldpingerAPI 

func NewGoldpingerAPI(spec *loads.Document) *GoldpingerAPI

NewGoldpingerAPI creates a new Goldpinger instance

func (*GoldpingerAPI) AuthenticatorsFor 

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

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*GoldpingerAPI) Authorizer 

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

Authorizer returns the registered authorizer

func (*GoldpingerAPI) ConsumersFor 

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

ConsumersFor gets the consumers for the specified media types

func (*GoldpingerAPI) Context 

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

Context returns the middleware context for the goldpinger API

func (*GoldpingerAPI) DefaultConsumes 

func (o *GoldpingerAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*GoldpingerAPI) DefaultProduces 

func (o *GoldpingerAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*GoldpingerAPI) Formats 

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

Formats returns the registered string formats

func (*GoldpingerAPI) HandlerFor 

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

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

func (*GoldpingerAPI) Init 

func (o *GoldpingerAPI) Init()

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

func (*GoldpingerAPI) ProducersFor 

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

ProducersFor gets the producers for the specified media types

func (*GoldpingerAPI) RegisterConsumer 

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

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

func (*GoldpingerAPI) RegisterFormat 

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

RegisterFormat registers a custom format validator

func (*GoldpingerAPI) RegisterProducer 

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

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

func (*GoldpingerAPI) Serve 

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

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

ServeErrorFor gets a error handler for a given operation id

func (*GoldpingerAPI) SetDefaultConsumes 

func (o *GoldpingerAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*GoldpingerAPI) SetDefaultProduces 

func (o *GoldpingerAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*GoldpingerAPI) SetSpec 

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

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

func (*GoldpingerAPI) Validate 

func (o *GoldpingerAPI) Validate() error

Validate validates the registrations in the GoldpingerAPI

type Healthz 

type Healthz struct {
	Context *middleware.Context
	Handler HealthzHandler
}

Healthz swagger:route GET /healthz healthz

The healthcheck endpoint provides detailed information about the health of a web service. If each of the components required by the service are healthy, then the service is considered healthy and will return a 200 OK response. If any of the components needed by the service are unhealthy, then a 503 Service Unavailable response will be provided.

func NewHealthz 

func NewHealthz(ctx *middleware.Context, handler HealthzHandler) *Healthz

NewHealthz creates a new http.Handler for the healthz operation

func (*Healthz) ServeHTTP 

func (o *Healthz) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type HealthzHandler 

type HealthzHandler interface {
	Handle(HealthzParams) middleware.Responder
}

HealthzHandler interface for that can handle valid healthz params

type HealthzHandlerFunc 

type HealthzHandlerFunc func(HealthzParams) middleware.Responder

HealthzHandlerFunc turns a function with the right signature into a healthz handler

func (HealthzHandlerFunc) Handle 

func (fn HealthzHandlerFunc) Handle(params HealthzParams) middleware.Responder

Handle executing the request and returning a response

type HealthzOK 

type HealthzOK struct {

	/*
	  In: Body
	*/
	Payload *models.HealthCheckResults `json:"body,omitempty"`
}

HealthzOK Health check report

swagger:response healthzOK

func NewHealthzOK 

func NewHealthzOK() *HealthzOK

NewHealthzOK creates HealthzOK with default headers values

func (*HealthzOK) SetPayload 

func (o *HealthzOK) SetPayload(payload *models.HealthCheckResults)

SetPayload sets the payload to the healthz o k response

func (*HealthzOK) WithPayload 

func (o *HealthzOK) WithPayload(payload *models.HealthCheckResults) *HealthzOK

WithPayload adds the payload to the healthz o k response

func (*HealthzOK) WriteResponse 

func (o *HealthzOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type HealthzParams 

type HealthzParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

HealthzParams contains all the bound params for the healthz operation typically these are obtained from a http.Request

swagger:parameters healthz

func NewHealthzParams 

func NewHealthzParams() HealthzParams

NewHealthzParams creates a new HealthzParams object no default values defined in spec.

func (*HealthzParams) BindRequest 

func (o *HealthzParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewHealthzParams() beforehand.

type HealthzServiceUnavailable 

type HealthzServiceUnavailable struct {

	/*
	  In: Body
	*/
	Payload *models.HealthCheckResults `json:"body,omitempty"`
}

HealthzServiceUnavailable Unhealthy service

swagger:response healthzServiceUnavailable

func NewHealthzServiceUnavailable 

func NewHealthzServiceUnavailable() *HealthzServiceUnavailable

NewHealthzServiceUnavailable creates HealthzServiceUnavailable with default headers values

func (*HealthzServiceUnavailable) SetPayload 

func (o *HealthzServiceUnavailable) SetPayload(payload *models.HealthCheckResults)

SetPayload sets the payload to the healthz service unavailable response

func (*HealthzServiceUnavailable) WithPayload 

func (o *HealthzServiceUnavailable) WithPayload(payload *models.HealthCheckResults) *HealthzServiceUnavailable

WithPayload adds the payload to the healthz service unavailable response

func (*HealthzServiceUnavailable) WriteResponse 

func (o *HealthzServiceUnavailable) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type HealthzURL 

type HealthzURL struct {
	// contains filtered or unexported fields
}

HealthzURL generates an URL for the healthz operation

func (*HealthzURL) Build 

func (o *HealthzURL) Build() (*url.URL, error)

Build a url path and query string

func (*HealthzURL) BuildFull 

func (o *HealthzURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*HealthzURL) Must 

func (o *HealthzURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*HealthzURL) SetBasePath 

func (o *HealthzURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*HealthzURL) String 

func (o *HealthzURL) String() string

String returns the string representation of the path with query string

func (*HealthzURL) StringFull 

func (o *HealthzURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*HealthzURL) WithBasePath 

func (o *HealthzURL) WithBasePath(bp string) *HealthzURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

type Ping 

type Ping struct {
	Context *middleware.Context
	Handler PingHandler
}

Ping swagger:route GET /ping ping

return query stats

func NewPing 

func NewPing(ctx *middleware.Context, handler PingHandler) *Ping

NewPing creates a new http.Handler for the ping operation

func (*Ping) ServeHTTP 

func (o *Ping) ServeHTTP(rw http.ResponseWriter, r *http.Request)

type PingHandler 

type PingHandler interface {
	Handle(PingParams) middleware.Responder
}

PingHandler interface for that can handle valid ping params

type PingHandlerFunc 

type PingHandlerFunc func(PingParams) middleware.Responder

PingHandlerFunc turns a function with the right signature into a ping handler

func (PingHandlerFunc) Handle 

func (fn PingHandlerFunc) Handle(params PingParams) middleware.Responder

Handle executing the request and returning a response

type PingOK 

type PingOK struct {

	/*
	  In: Body
	*/
	Payload *models.PingResults `json:"body,omitempty"`
}

PingOK return success

swagger:response pingOK

func NewPingOK 

func NewPingOK() *PingOK

NewPingOK creates PingOK with default headers values

func (*PingOK) SetPayload 

func (o *PingOK) SetPayload(payload *models.PingResults)

SetPayload sets the payload to the ping o k response

func (*PingOK) WithPayload 

func (o *PingOK) WithPayload(payload *models.PingResults) *PingOK

WithPayload adds the payload to the ping o k response

func (*PingOK) WriteResponse 

func (o *PingOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)

WriteResponse to the client

type PingParams 

type PingParams struct {

	// HTTP Request Object
	HTTPRequest *http.Request `json:"-"`
}

PingParams contains all the bound params for the ping operation typically these are obtained from a http.Request

swagger:parameters ping

func NewPingParams 

func NewPingParams() PingParams

NewPingParams creates a new PingParams object no default values defined in spec.

func (*PingParams) BindRequest 

func (o *PingParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error

BindRequest both binds and validates a request, it assumes that complex things implement a Validatable(strfmt.Registry) error interface for simple values it will use straight method calls.

To ensure default values, the struct must have been initialized with NewPingParams() beforehand.

type PingURL 

type PingURL struct {
	// contains filtered or unexported fields
}

PingURL generates an URL for the ping operation

func (*PingURL) Build 

func (o *PingURL) Build() (*url.URL, error)

Build a url path and query string

func (*PingURL) BuildFull 

func (o *PingURL) BuildFull(scheme, host string) (*url.URL, error)

BuildFull builds a full url with scheme, host, path and query string

func (*PingURL) Must 

func (o *PingURL) Must(u *url.URL, err error) *url.URL

Must is a helper function to panic when the url builder returns an error

func (*PingURL) SetBasePath 

func (o *PingURL) SetBasePath(bp string)

SetBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

func (*PingURL) String 

func (o *PingURL) String() string

String returns the string representation of the path with query string

func (*PingURL) StringFull 

func (o *PingURL) StringFull(scheme, host string) string

StringFull returns the string representation of a complete url

func (*PingURL) WithBasePath 

func (o *PingURL) WithBasePath(bp string) *PingURL

WithBasePath sets the base path for this url builder, only required when it's different from the base path specified in the swagger spec. When the value of the base path is an empty string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.