health

package
v0.0.0-...-25ad089 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2021 License: AGPL-3.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const IsHealthyInternalServerErrorCode int = 500

IsHealthyInternalServerErrorCode is the HTTP code returned for type IsHealthyInternalServerError

View Source 
const IsHealthyOKCode int = 200

IsHealthyOKCode is the HTTP code returned for type IsHealthyOK

View Source 
const IsHealthyServiceUnavailableCode int = 503

IsHealthyServiceUnavailableCode is the HTTP code returned for type IsHealthyServiceUnavailable

View Source 
const IsReadyInternalServerErrorCode int = 500

IsReadyInternalServerErrorCode is the HTTP code returned for type IsReadyInternalServerError

View Source 
const IsReadyOKCode int = 200

IsReadyOKCode is the HTTP code returned for type IsReadyOK

View Source 
const IsReadyServiceUnavailableCode int = 503

IsReadyServiceUnavailableCode is the HTTP code returned for type IsReadyServiceUnavailable

Variables

This section is empty.

Functions

This section is empty.

Types

type IsHealthy 

type IsHealthy struct {
	Context *middleware.Context
	Handler IsHealthyHandler
}
IsHealthy swagger:route GET /-/healthy health isHealthy

Check health status

This endpoint returns a 200 status code when the HTTP server is up running.

func NewIsHealthy 

func NewIsHealthy(ctx *middleware.Context, handler IsHealthyHandler) *IsHealthy

NewIsHealthy creates a new http.Handler for the is healthy operation

func (*IsHealthy) ServeHTTP 

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

type IsHealthyHandler 

type IsHealthyHandler interface {
	Handle(IsHealthyParams) middleware.Responder
}

IsHealthyHandler interface for that can handle valid is healthy params

type IsHealthyHandlerFunc 

type IsHealthyHandlerFunc func(IsHealthyParams) middleware.Responder

IsHealthyHandlerFunc turns a function with the right signature into a is healthy handler

func (IsHealthyHandlerFunc) Handle 

func (fn IsHealthyHandlerFunc) Handle(params IsHealthyParams) middleware.Responder

Handle executing the request and returning a response

type IsHealthyInternalServerError 

type IsHealthyInternalServerError struct {

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

IsHealthyInternalServerError The standard error format

swagger:response isHealthyInternalServerError

func NewIsHealthyInternalServerError 

func NewIsHealthyInternalServerError() *IsHealthyInternalServerError

NewIsHealthyInternalServerError creates IsHealthyInternalServerError with default headers values

func (*IsHealthyInternalServerError) SetPayload 

func (o *IsHealthyInternalServerError) SetPayload(payload *models.StandardError)

SetPayload sets the payload to the is healthy internal server error response

func (*IsHealthyInternalServerError) WithPayload 

func (o *IsHealthyInternalServerError) WithPayload(payload *models.StandardError) *IsHealthyInternalServerError

WithPayload adds the payload to the is healthy internal server error response

func (*IsHealthyInternalServerError) WriteResponse 

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

WriteResponse to the client

type IsHealthyOK 

type IsHealthyOK struct {

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

IsHealthyOK healthStatus

swagger:response isHealthyOK

func NewIsHealthyOK 

func NewIsHealthyOK() *IsHealthyOK

NewIsHealthyOK creates IsHealthyOK with default headers values

func (*IsHealthyOK) SetPayload 

func (o *IsHealthyOK) SetPayload(payload *models.HealthHealthy)

SetPayload sets the payload to the is healthy o k response

func (*IsHealthyOK) WithPayload 

func (o *IsHealthyOK) WithPayload(payload *models.HealthHealthy) *IsHealthyOK

WithPayload adds the payload to the is healthy o k response

func (*IsHealthyOK) WriteResponse 

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

WriteResponse to the client

type IsHealthyParams 

type IsHealthyParams struct {

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

IsHealthyParams contains all the bound params for the is healthy operation typically these are obtained from a http.Request

swagger:parameters isHealthy

func NewIsHealthyParams 

func NewIsHealthyParams() IsHealthyParams

NewIsHealthyParams creates a new IsHealthyParams object

There are no default values defined in the spec.

func (*IsHealthyParams) BindRequest 

func (o *IsHealthyParams) 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 NewIsHealthyParams() beforehand.

type IsHealthyServiceUnavailable 

type IsHealthyServiceUnavailable struct {

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

IsHealthyServiceUnavailable healthNotHealthyStatus

swagger:response isHealthyServiceUnavailable

func NewIsHealthyServiceUnavailable 

func NewIsHealthyServiceUnavailable() *IsHealthyServiceUnavailable

NewIsHealthyServiceUnavailable creates IsHealthyServiceUnavailable with default headers values

func (*IsHealthyServiceUnavailable) SetPayload 

func (o *IsHealthyServiceUnavailable) SetPayload(payload *models.HealthServiceUnavailable)

SetPayload sets the payload to the is healthy service unavailable response

func (*IsHealthyServiceUnavailable) WithPayload 

func (o *IsHealthyServiceUnavailable) WithPayload(payload *models.HealthServiceUnavailable) *IsHealthyServiceUnavailable

WithPayload adds the payload to the is healthy service unavailable response

func (*IsHealthyServiceUnavailable) WriteResponse 

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

WriteResponse to the client

type IsHealthyURL 

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

IsHealthyURL generates an URL for the is healthy operation

func (*IsHealthyURL) Build 

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

Build a url path and query string

func (*IsHealthyURL) BuildFull 

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

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

func (*IsHealthyURL) Must 

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

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

func (*IsHealthyURL) SetBasePath 

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

func (o *IsHealthyURL) String() string

String returns the string representation of the path with query string

func (*IsHealthyURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*IsHealthyURL) WithBasePath 

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

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 IsReady 

type IsReady struct {
	Context *middleware.Context
	Handler IsReadyHandler
}
IsReady swagger:route GET /-/ready health isReady

Check readiness status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies are responsive as well.

func NewIsReady 

func NewIsReady(ctx *middleware.Context, handler IsReadyHandler) *IsReady

NewIsReady creates a new http.Handler for the is ready operation

func (*IsReady) ServeHTTP 

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

type IsReadyHandler 

type IsReadyHandler interface {
	Handle(IsReadyParams) middleware.Responder
}

IsReadyHandler interface for that can handle valid is ready params

type IsReadyHandlerFunc 

type IsReadyHandlerFunc func(IsReadyParams) middleware.Responder

IsReadyHandlerFunc turns a function with the right signature into a is ready handler

func (IsReadyHandlerFunc) Handle 

func (fn IsReadyHandlerFunc) Handle(params IsReadyParams) middleware.Responder

Handle executing the request and returning a response

type IsReadyInternalServerError 

type IsReadyInternalServerError struct {

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

IsReadyInternalServerError The standard error format

swagger:response isReadyInternalServerError

func NewIsReadyInternalServerError 

func NewIsReadyInternalServerError() *IsReadyInternalServerError

NewIsReadyInternalServerError creates IsReadyInternalServerError with default headers values

func (*IsReadyInternalServerError) SetPayload 

func (o *IsReadyInternalServerError) SetPayload(payload *models.StandardError)

SetPayload sets the payload to the is ready internal server error response

func (*IsReadyInternalServerError) WithPayload 

func (o *IsReadyInternalServerError) WithPayload(payload *models.StandardError) *IsReadyInternalServerError

WithPayload adds the payload to the is ready internal server error response

func (*IsReadyInternalServerError) WriteResponse 

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

WriteResponse to the client

type IsReadyOK 

type IsReadyOK struct {

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

IsReadyOK healthStatus

swagger:response isReadyOK

func NewIsReadyOK 

func NewIsReadyOK() *IsReadyOK

NewIsReadyOK creates IsReadyOK with default headers values

func (*IsReadyOK) SetPayload 

func (o *IsReadyOK) SetPayload(payload *models.HealthHealthy)

SetPayload sets the payload to the is ready o k response

func (*IsReadyOK) WithPayload 

func (o *IsReadyOK) WithPayload(payload *models.HealthHealthy) *IsReadyOK

WithPayload adds the payload to the is ready o k response

func (*IsReadyOK) WriteResponse 

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

WriteResponse to the client

type IsReadyParams 

type IsReadyParams struct {

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

IsReadyParams contains all the bound params for the is ready operation typically these are obtained from a http.Request

swagger:parameters isReady

func NewIsReadyParams 

func NewIsReadyParams() IsReadyParams

NewIsReadyParams creates a new IsReadyParams object

There are no default values defined in the spec.

func (*IsReadyParams) BindRequest 

func (o *IsReadyParams) 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 NewIsReadyParams() beforehand.

type IsReadyServiceUnavailable 

type IsReadyServiceUnavailable struct {

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

IsReadyServiceUnavailable healthNotReadyStatus

swagger:response isReadyServiceUnavailable

func NewIsReadyServiceUnavailable 

func NewIsReadyServiceUnavailable() *IsReadyServiceUnavailable

NewIsReadyServiceUnavailable creates IsReadyServiceUnavailable with default headers values

func (*IsReadyServiceUnavailable) SetPayload 

func (o *IsReadyServiceUnavailable) SetPayload(payload *models.HealthServiceUnavailable)

SetPayload sets the payload to the is ready service unavailable response

func (*IsReadyServiceUnavailable) WithPayload 

func (o *IsReadyServiceUnavailable) WithPayload(payload *models.HealthServiceUnavailable) *IsReadyServiceUnavailable

WithPayload adds the payload to the is ready service unavailable response

func (*IsReadyServiceUnavailable) WriteResponse 

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

WriteResponse to the client

type IsReadyURL 

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

IsReadyURL generates an URL for the is ready operation

func (*IsReadyURL) Build 

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

Build a url path and query string

func (*IsReadyURL) BuildFull 

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

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

func (*IsReadyURL) Must 

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

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

func (*IsReadyURL) SetBasePath 

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

func (o *IsReadyURL) String() string

String returns the string representation of the path with query string

func (*IsReadyURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*IsReadyURL) WithBasePath 

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

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.