Documentation
¶
Index ¶
- Constants
- type Readyz
- type ReadyzHandler
- type ReadyzHandlerFunc
- type ReadyzOK
- type ReadyzParams
- type ReadyzURL
- func (o *ReadyzURL) Build() (*url.URL, error)
- func (o *ReadyzURL) BuildFull(scheme, host string) (*url.URL, error)
- func (o *ReadyzURL) Must(u *url.URL, err error) *url.URL
- func (o *ReadyzURL) SetBasePath(bp string)
- func (o *ReadyzURL) String() string
- func (o *ReadyzURL) StringFull(scheme, host string) string
- func (o *ReadyzURL) WithBasePath(bp string) *ReadyzURL
Constants ¶
const ReadyzOKCode int = 200
ReadyzOKCode is the HTTP code returned for type ReadyzOK
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Readyz ¶
type Readyz struct {
Context *middleware.Context
Handler ReadyzHandler
}
Readyz swagger:route GET /readyz Service readyz
Ready status
func NewReadyz ¶
func NewReadyz(ctx *middleware.Context, handler ReadyzHandler) *Readyz
NewReadyz creates a new http.Handler for the readyz operation
type ReadyzHandler ¶
type ReadyzHandler interface {
Handle(ReadyzParams) middleware.Responder
}
ReadyzHandler interface for that can handle valid readyz params
type ReadyzHandlerFunc ¶
type ReadyzHandlerFunc func(ReadyzParams) middleware.Responder
ReadyzHandlerFunc turns a function with the right signature into a readyz handler
func (ReadyzHandlerFunc) Handle ¶
func (fn ReadyzHandlerFunc) Handle(params ReadyzParams) middleware.Responder
Handle executing the request and returning a response
type ReadyzOK ¶
type ReadyzOK struct {
/*
In: Body
*/
Payload models.ReadyStatus `json:"body,omitempty"`
}
ReadyzOK Ready status
swagger:response readyzOK
func NewReadyzOK ¶
func NewReadyzOK() *ReadyzOK
NewReadyzOK creates ReadyzOK with default headers values
func (*ReadyzOK) SetPayload ¶
func (o *ReadyzOK) SetPayload(payload models.ReadyStatus)
SetPayload sets the payload to the readyz o k response
func (*ReadyzOK) WithPayload ¶
func (o *ReadyzOK) WithPayload(payload models.ReadyStatus) *ReadyzOK
WithPayload adds the payload to the readyz o k response
func (*ReadyzOK) WriteResponse ¶
func (o *ReadyzOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
WriteResponse to the client
type ReadyzParams ¶
ReadyzParams contains all the bound params for the readyz operation typically these are obtained from a http.Request
swagger:parameters readyz
func NewReadyzParams ¶
func NewReadyzParams() ReadyzParams
NewReadyzParams creates a new ReadyzParams object
There are no default values defined in the spec.
func (*ReadyzParams) BindRequest ¶
func (o *ReadyzParams) 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 NewReadyzParams() beforehand.
type ReadyzURL ¶
type ReadyzURL struct {
// contains filtered or unexported fields
}
ReadyzURL generates an URL for the readyz operation
func (*ReadyzURL) SetBasePath ¶
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 (*ReadyzURL) StringFull ¶
StringFull returns the string representation of a complete url
func (*ReadyzURL) WithBasePath ¶
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