healthz

Documentation

Index

• Constants
• type GetHealthz
  • func NewGetHealthz(ctx *middleware.Context, handler GetHealthzHandler) *GetHealthz
  • func (o *GetHealthz) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetHealthzDefault
  • func NewGetHealthzDefault(code int) *GetHealthzDefault
  • func (o *GetHealthzDefault) SetPayload(payload *models.Error)
  • func (o *GetHealthzDefault) SetStatusCode(code int)
  • func (o *GetHealthzDefault) WithPayload(payload *models.Error) *GetHealthzDefault
  • func (o *GetHealthzDefault) WithStatusCode(code int) *GetHealthzDefault
  • func (o *GetHealthzDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetHealthzHandler
• type GetHealthzHandlerFunc
  • func (fn GetHealthzHandlerFunc) Handle(params GetHealthzParams) middleware.Responder
• type GetHealthzOK
  • func NewGetHealthzOK() *GetHealthzOK
  • func (o *GetHealthzOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetHealthzParams
  • func NewGetHealthzParams() GetHealthzParams
  • func (o *GetHealthzParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetHealthzURL
  • func (o *GetHealthzURL) Build() (*url.URL, error)
  • func (o *GetHealthzURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetHealthzURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetHealthzURL) SetBasePath(bp string)
  • func (o *GetHealthzURL) String() string
  • func (o *GetHealthzURL) StringFull(scheme, host string) string
  • func (o *GetHealthzURL) WithBasePath(bp string) *GetHealthzURL

Constants

const GetHealthzOKCode int = 200

GetHealthzOKCode is the HTTP code returned for type GetHealthzOK

Types

type GetHealthz

type GetHealthz struct {
	Context *middleware.Context
	Handler GetHealthzHandler
}

GetHealthz swagger:route GET /healthz healthz getHealthz

Returns the health of the application

func NewGetHealthz

func NewGetHealthz(ctx *middleware.Context, handler GetHealthzHandler) *GetHealthz

NewGetHealthz creates a new http.Handler for the get healthz operation

func (*GetHealthz) ServeHTTP

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

type GetHealthzDefault

type GetHealthzDefault struct {

	/*
	  In: Body
	*/
	Payload *models.Error `json:"body,omitempty"`
	// contains filtered or unexported fields
}

GetHealthzDefault unexpected error

swagger:response getHealthzDefault

func NewGetHealthzDefault

func NewGetHealthzDefault(code int) *GetHealthzDefault

NewGetHealthzDefault creates GetHealthzDefault with default headers values

func (*GetHealthzDefault) SetPayload

func (o *GetHealthzDefault) SetPayload(payload *models.Error)

SetPayload sets the payload to the get healthz default response

func (*GetHealthzDefault) SetStatusCode

func (o *GetHealthzDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get healthz default response

func (*GetHealthzDefault) WithPayload

func (o *GetHealthzDefault) WithPayload(payload *models.Error) *GetHealthzDefault

WithPayload adds the payload to the get healthz default response

func (*GetHealthzDefault) WithStatusCode

func (o *GetHealthzDefault) WithStatusCode(code int) *GetHealthzDefault

WithStatusCode adds the status to the get healthz default response

func (*GetHealthzDefault) WriteResponse

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

WriteResponse to the client

type GetHealthzHandler

type GetHealthzHandler interface {
	Handle(GetHealthzParams) middleware.Responder
}

GetHealthzHandler interface for that can handle valid get healthz params

type GetHealthzHandlerFunc

type GetHealthzHandlerFunc func(GetHealthzParams) middleware.Responder

GetHealthzHandlerFunc turns a function with the right signature into a get healthz handler

func (GetHealthzHandlerFunc) Handle

func (fn GetHealthzHandlerFunc) Handle(params GetHealthzParams) middleware.Responder

Handle executing the request and returning a response

type GetHealthzOK

type GetHealthzOK struct {
}

GetHealthzOK The response indicating that the application is healthy.

swagger:response getHealthzOK

func NewGetHealthzOK

func NewGetHealthzOK() *GetHealthzOK

NewGetHealthzOK creates GetHealthzOK with default headers values

func (*GetHealthzOK) WriteResponse

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

WriteResponse to the client

type GetHealthzParams

type GetHealthzParams struct {

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

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

swagger:parameters getHealthz

func NewGetHealthzParams

func NewGetHealthzParams() GetHealthzParams

NewGetHealthzParams creates a new GetHealthzParams object no default values defined in spec.

func (*GetHealthzParams) BindRequest

func (o *GetHealthzParams) 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 NewGetHealthzParams() beforehand.

type GetHealthzURL

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

GetHealthzURL generates an URL for the get healthz operation

func (*GetHealthzURL) Build

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

Build a url path and query string

func (*GetHealthzURL) BuildFull

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

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

func (*GetHealthzURL) Must

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

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

func (*GetHealthzURL) SetBasePath

func (o *GetHealthzURL) 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 (*GetHealthzURL) String

func (o *GetHealthzURL) String() string

String returns the string representation of the path with query string

func (*GetHealthzURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetHealthzURL) WithBasePath

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

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