health

package
v0.10.6 Latest Latest
Warning

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

 Go to latest Published: Dec 11, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const GetLivenessOKCode int = 200

GetLivenessOKCode is the HTTP code returned for type GetLivenessOK

View Source 
const GetReadinessOKCode int = 200

GetReadinessOKCode is the HTTP code returned for type GetReadinessOK

Variables

This section is empty.

Functions

This section is empty.

Types

type GetLiveness 

type GetLiveness struct {
	Context *middleware.Context
	Handler GetLivenessHandler
}
GetLiveness swagger:route GET /liveness health getLiveness

Check if Goliac is healthy

func NewGetLiveness 

func NewGetLiveness(ctx *middleware.Context, handler GetLivenessHandler) *GetLiveness

NewGetLiveness creates a new http.Handler for the get liveness operation

func (*GetLiveness) ServeHTTP 

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

type GetLivenessDefault 

type GetLivenessDefault struct {

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

GetLivenessDefault generic error response

swagger:response getLivenessDefault

func NewGetLivenessDefault 

func NewGetLivenessDefault(code int) *GetLivenessDefault

NewGetLivenessDefault creates GetLivenessDefault with default headers values

func (*GetLivenessDefault) SetPayload 

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

SetPayload sets the payload to the get liveness default response

func (*GetLivenessDefault) SetStatusCode 

func (o *GetLivenessDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get liveness default response

func (*GetLivenessDefault) WithPayload 

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

WithPayload adds the payload to the get liveness default response

func (*GetLivenessDefault) WithStatusCode 

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

WithStatusCode adds the status to the get liveness default response

func (*GetLivenessDefault) WriteResponse 

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

WriteResponse to the client

type GetLivenessHandler 

type GetLivenessHandler interface {
	Handle(GetLivenessParams) middleware.Responder
}

GetLivenessHandler interface for that can handle valid get liveness params

type GetLivenessHandlerFunc 

type GetLivenessHandlerFunc func(GetLivenessParams) middleware.Responder

GetLivenessHandlerFunc turns a function with the right signature into a get liveness handler

func (GetLivenessHandlerFunc) Handle 

func (fn GetLivenessHandlerFunc) Handle(params GetLivenessParams) middleware.Responder

Handle executing the request and returning a response

type GetLivenessOK 

type GetLivenessOK struct {

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

GetLivenessOK status of health check

swagger:response getLivenessOK

func NewGetLivenessOK 

func NewGetLivenessOK() *GetLivenessOK

NewGetLivenessOK creates GetLivenessOK with default headers values

func (*GetLivenessOK) SetPayload 

func (o *GetLivenessOK) SetPayload(payload *models.Health)

SetPayload sets the payload to the get liveness o k response

func (*GetLivenessOK) WithPayload 

func (o *GetLivenessOK) WithPayload(payload *models.Health) *GetLivenessOK

WithPayload adds the payload to the get liveness o k response

func (*GetLivenessOK) WriteResponse 

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

WriteResponse to the client

type GetLivenessParams 

type GetLivenessParams struct {

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

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

swagger:parameters getLiveness

func NewGetLivenessParams 

func NewGetLivenessParams() GetLivenessParams

NewGetLivenessParams creates a new GetLivenessParams object

There are no default values defined in the spec.

func (*GetLivenessParams) BindRequest 

func (o *GetLivenessParams) 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 NewGetLivenessParams() beforehand.

type GetLivenessURL 

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

GetLivenessURL generates an URL for the get liveness operation

func (*GetLivenessURL) Build 

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

Build a url path and query string

func (*GetLivenessURL) BuildFull 

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

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

func (*GetLivenessURL) Must 

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

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

func (*GetLivenessURL) SetBasePath 

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

func (o *GetLivenessURL) String() string

String returns the string representation of the path with query string

func (*GetLivenessURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetLivenessURL) WithBasePath 

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

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 GetReadiness 

type GetReadiness struct {
	Context *middleware.Context
	Handler GetReadinessHandler
}
GetReadiness swagger:route GET /readiness health getReadiness

Check if Goliac is ready to serve

func NewGetReadiness 

func NewGetReadiness(ctx *middleware.Context, handler GetReadinessHandler) *GetReadiness

NewGetReadiness creates a new http.Handler for the get readiness operation

func (*GetReadiness) ServeHTTP 

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

type GetReadinessDefault 

type GetReadinessDefault struct {

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

GetReadinessDefault generic error response

swagger:response getReadinessDefault

func NewGetReadinessDefault 

func NewGetReadinessDefault(code int) *GetReadinessDefault

NewGetReadinessDefault creates GetReadinessDefault with default headers values

func (*GetReadinessDefault) SetPayload 

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

SetPayload sets the payload to the get readiness default response

func (*GetReadinessDefault) SetStatusCode 

func (o *GetReadinessDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get readiness default response

func (*GetReadinessDefault) WithPayload 

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

WithPayload adds the payload to the get readiness default response

func (*GetReadinessDefault) WithStatusCode 

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

WithStatusCode adds the status to the get readiness default response

func (*GetReadinessDefault) WriteResponse 

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

WriteResponse to the client

type GetReadinessHandler 

type GetReadinessHandler interface {
	Handle(GetReadinessParams) middleware.Responder
}

GetReadinessHandler interface for that can handle valid get readiness params

type GetReadinessHandlerFunc 

type GetReadinessHandlerFunc func(GetReadinessParams) middleware.Responder

GetReadinessHandlerFunc turns a function with the right signature into a get readiness handler

func (GetReadinessHandlerFunc) Handle 

func (fn GetReadinessHandlerFunc) Handle(params GetReadinessParams) middleware.Responder

Handle executing the request and returning a response

type GetReadinessOK 

type GetReadinessOK struct {

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

GetReadinessOK status of health check

swagger:response getReadinessOK

func NewGetReadinessOK 

func NewGetReadinessOK() *GetReadinessOK

NewGetReadinessOK creates GetReadinessOK with default headers values

func (*GetReadinessOK) SetPayload 

func (o *GetReadinessOK) SetPayload(payload *models.Health)

SetPayload sets the payload to the get readiness o k response

func (*GetReadinessOK) WithPayload 

func (o *GetReadinessOK) WithPayload(payload *models.Health) *GetReadinessOK

WithPayload adds the payload to the get readiness o k response

func (*GetReadinessOK) WriteResponse 

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

WriteResponse to the client

type GetReadinessParams 

type GetReadinessParams struct {

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

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

swagger:parameters getReadiness

func NewGetReadinessParams 

func NewGetReadinessParams() GetReadinessParams

NewGetReadinessParams creates a new GetReadinessParams object

There are no default values defined in the spec.

func (*GetReadinessParams) BindRequest 

func (o *GetReadinessParams) 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 NewGetReadinessParams() beforehand.

type GetReadinessURL 

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

GetReadinessURL generates an URL for the get readiness operation

func (*GetReadinessURL) Build 

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

Build a url path and query string

func (*GetReadinessURL) BuildFull 

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

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

func (*GetReadinessURL) Must 

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

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

func (*GetReadinessURL) SetBasePath 

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

func (o *GetReadinessURL) String() string

String returns the string representation of the path with query string

func (*GetReadinessURL) StringFull 

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

StringFull returns the string representation of a complete url

func (*GetReadinessURL) WithBasePath 

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

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.