Documentation
¶
Index ¶
- Constants
- type GetHealth
- type GetHealthDefault
- func (o *GetHealthDefault) SetPayload(payload *models.Error)
- func (o *GetHealthDefault) SetStatusCode(code int)
- func (o *GetHealthDefault) WithPayload(payload *models.Error) *GetHealthDefault
- func (o *GetHealthDefault) WithStatusCode(code int) *GetHealthDefault
- func (o *GetHealthDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
- type GetHealthHandler
- type GetHealthHandlerFunc
- type GetHealthOK
- type GetHealthParams
- type GetHealthURL
- func (o *GetHealthURL) Build() (*url.URL, error)
- func (o *GetHealthURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *GetHealthURL) Must(u *url.URL, err error) *url.URL
- func (o *GetHealthURL) SetBasePath(bp string)
- func (o *GetHealthURL) String() string
- func (o *GetHealthURL) StringFull(scheme, host string) string
- func (o *GetHealthURL) WithBasePath(bp string) *GetHealthURL
Constants ¶
const GetHealthOKCode int = 200
GetHealthOKCode is the HTTP code returned for type GetHealthOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetHealth ¶
type GetHealth struct {
Context *middleware.Context
Handler GetHealthHandler
}
GetHealth swagger:route GET /health health getHealth
Check if Flagr is healthy
func NewGetHealth ¶
func NewGetHealth(ctx *middleware.Context, handler GetHealthHandler) *GetHealth
NewGetHealth creates a new http.Handler for the get health operation
type GetHealthDefault ¶
type GetHealthDefault struct {
/*
In: Body
*/
Payload *models.Error `json:"body,omitempty"`
// contains filtered or unexported fields
}
GetHealthDefault generic error response
swagger:response getHealthDefault
func NewGetHealthDefault ¶
func NewGetHealthDefault(code int) *GetHealthDefault
NewGetHealthDefault creates GetHealthDefault with default headers values
func (*GetHealthDefault) SetPayload ¶
func (o *GetHealthDefault) SetPayload(payload *models.Error)
SetPayload sets the payload to the get health default response
func (*GetHealthDefault) SetStatusCode ¶
func (o *GetHealthDefault) SetStatusCode(code int)
SetStatusCode sets the status to the get health default response
func (*GetHealthDefault) WithPayload ¶
func (o *GetHealthDefault) WithPayload(payload *models.Error) *GetHealthDefault
WithPayload adds the payload to the get health default response
func (*GetHealthDefault) WithStatusCode ¶
func (o *GetHealthDefault) WithStatusCode(code int) *GetHealthDefault
WithStatusCode adds the status to the get health default response
func (*GetHealthDefault) WriteResponse ¶
func (o *GetHealthDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetHealthHandler ¶
type GetHealthHandler interface {
Handle(GetHealthParams) middleware.Responder
}
GetHealthHandler interface for that can handle valid get health params
type GetHealthHandlerFunc ¶
type GetHealthHandlerFunc func(GetHealthParams) middleware.Responder
GetHealthHandlerFunc turns a function with the right signature into a get health handler
func (GetHealthHandlerFunc) Handle ¶
func (fn GetHealthHandlerFunc) Handle(params GetHealthParams) middleware.Responder
Handle executing the request and returning a response
type GetHealthOK ¶
GetHealthOK status of health check
swagger:response getHealthOK
func NewGetHealthOK ¶
func NewGetHealthOK() *GetHealthOK
NewGetHealthOK creates GetHealthOK with default headers values
func (*GetHealthOK) SetPayload ¶
func (o *GetHealthOK) SetPayload(payload *models.Health)
SetPayload sets the payload to the get health o k response
func (*GetHealthOK) WithPayload ¶
func (o *GetHealthOK) WithPayload(payload *models.Health) *GetHealthOK
WithPayload adds the payload to the get health o k response
func (*GetHealthOK) WriteResponse ¶
func (o *GetHealthOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type GetHealthParams ¶
GetHealthParams contains all the bound params for the get health operation typically these are obtained from a http.Request
swagger:parameters getHealth
func NewGetHealthParams ¶
func NewGetHealthParams() GetHealthParams
NewGetHealthParams creates a new GetHealthParams object no default values defined in spec.
func (*GetHealthParams) BindRequest ¶
func (o *GetHealthParams) 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 NewGetHealthParams() beforehand.
type GetHealthURL ¶
type GetHealthURL struct {
// contains filtered or unexported fields
}
GetHealthURL generates an URL for the get health operation
func (*GetHealthURL) Build ¶
func (o *GetHealthURL) Build() (*url.URL, error)
Build a url path and query string
func (*GetHealthURL) BuildFull ¶
func (o *GetHealthURL) BuildFull(scheme, host string) (*url.URL, error)
BuildFull builds a full url with scheme, host, path and query string
func (*GetHealthURL) Must ¶
Must is a helper function to panic when the url builder returns an error
func (*GetHealthURL) SetBasePath ¶
func (o *GetHealthURL) 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 (*GetHealthURL) String ¶
func (o *GetHealthURL) String() string
String returns the string representation of the path with query string
func (*GetHealthURL) StringFull ¶
func (o *GetHealthURL) StringFull(scheme, host string) string
StringFull returns the string representation of a complete url
func (*GetHealthURL) WithBasePath ¶
func (o *GetHealthURL) WithBasePath(bp string) *GetHealthURL
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