liveness

Documentation

Index

• Constants
• type GetLive
  • func NewGetLive(ctx *middleware.Context, handler GetLiveHandler) *GetLive
  • func (o *GetLive) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetLiveDefault
  • func NewGetLiveDefault(code int) *GetLiveDefault
  • func (o *GetLiveDefault) SetPayload(payload *models.Error)
  • func (o *GetLiveDefault) SetStatusCode(code int)
  • func (o *GetLiveDefault) WithPayload(payload *models.Error) *GetLiveDefault
  • func (o *GetLiveDefault) WithStatusCode(code int) *GetLiveDefault
  • func (o *GetLiveDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetLiveHandler
• type GetLiveHandlerFunc
  • func (fn GetLiveHandlerFunc) Handle(params GetLiveParams) middleware.Responder
• type GetLiveOK
  • func NewGetLiveOK() *GetLiveOK
  • func (o *GetLiveOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetLiveParams
  • func NewGetLiveParams() GetLiveParams
  • func (o *GetLiveParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetLiveServiceUnavailable
  • func NewGetLiveServiceUnavailable() *GetLiveServiceUnavailable
  • func (o *GetLiveServiceUnavailable) SetPayload(payload *models.Error)
  • func (o *GetLiveServiceUnavailable) WithPayload(payload *models.Error) *GetLiveServiceUnavailable
  • func (o *GetLiveServiceUnavailable) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetLiveURL
  • func (o *GetLiveURL) Build() (*url.URL, error)
  • func (o *GetLiveURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetLiveURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetLiveURL) SetBasePath(bp string)
  • func (o *GetLiveURL) String() string
  • func (o *GetLiveURL) StringFull(scheme, host string) string
  • func (o *GetLiveURL) WithBasePath(bp string) *GetLiveURL

Constants

const GetLiveOKCode int = 200

GetLiveOKCode is the HTTP code returned for type GetLiveOK

const GetLiveServiceUnavailableCode int = 503

GetLiveServiceUnavailableCode is the HTTP code returned for type GetLiveServiceUnavailable

Types

type GetLive

type GetLive struct {
	Context *middleware.Context
	Handler GetLiveHandler
}

GetLive swagger:route GET /live liveness getLive

GetLive get live API

func NewGetLive

func NewGetLive(ctx *middleware.Context, handler GetLiveHandler) *GetLive

NewGetLive creates a new http.Handler for the get live operation

func (*GetLive) ServeHTTP

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

type GetLiveDefault

type GetLiveDefault struct {

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

GetLiveDefault generic error response

swagger:response getLiveDefault

func NewGetLiveDefault

func NewGetLiveDefault(code int) *GetLiveDefault

NewGetLiveDefault creates GetLiveDefault with default headers values

func (*GetLiveDefault) SetPayload

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

SetPayload sets the payload to the get live default response

func (*GetLiveDefault) SetStatusCode

func (o *GetLiveDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get live default response

func (*GetLiveDefault) WithPayload

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

WithPayload adds the payload to the get live default response

func (*GetLiveDefault) WithStatusCode

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

WithStatusCode adds the status to the get live default response

func (*GetLiveDefault) WriteResponse

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

WriteResponse to the client

type GetLiveHandler

type GetLiveHandler interface {
	Handle(GetLiveParams) middleware.Responder
}

GetLiveHandler interface for that can handle valid get live params

type GetLiveHandlerFunc

type GetLiveHandlerFunc func(GetLiveParams) middleware.Responder

GetLiveHandlerFunc turns a function with the right signature into a get live handler

func (GetLiveHandlerFunc) Handle

func (fn GetLiveHandlerFunc) Handle(params GetLiveParams) middleware.Responder

Handle executing the request and returning a response

type GetLiveOK

type GetLiveOK struct {
}

GetLiveOK liveness probe

swagger:response getLiveOK

func NewGetLiveOK

func NewGetLiveOK() *GetLiveOK

NewGetLiveOK creates GetLiveOK with default headers values

func (*GetLiveOK) WriteResponse

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

WriteResponse to the client

type GetLiveParams

type GetLiveParams struct {

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

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

swagger:parameters GetLive

func NewGetLiveParams

func NewGetLiveParams() GetLiveParams

NewGetLiveParams creates a new GetLiveParams object no default values defined in spec.

func (*GetLiveParams) BindRequest

func (o *GetLiveParams) 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 NewGetLiveParams() beforehand.

type GetLiveServiceUnavailable

type GetLiveServiceUnavailable struct {

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

GetLiveServiceUnavailable if not alive

swagger:response getLiveServiceUnavailable

func NewGetLiveServiceUnavailable

func NewGetLiveServiceUnavailable() *GetLiveServiceUnavailable

NewGetLiveServiceUnavailable creates GetLiveServiceUnavailable with default headers values

func (*GetLiveServiceUnavailable) SetPayload

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

SetPayload sets the payload to the get live service unavailable response

func (*GetLiveServiceUnavailable) WithPayload

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

WithPayload adds the payload to the get live service unavailable response

func (*GetLiveServiceUnavailable) WriteResponse

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

WriteResponse to the client

type GetLiveURL

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

GetLiveURL generates an URL for the get live operation

func (*GetLiveURL) Build

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

Build a url path and query string

func (*GetLiveURL) BuildFull

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

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

func (*GetLiveURL) Must

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

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

func (*GetLiveURL) SetBasePath

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

func (o *GetLiveURL) String() string

String returns the string representation of the path with query string

func (*GetLiveURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetLiveURL) WithBasePath

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

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