readiness

Documentation

Index

• Constants
• type GetReady
  • func NewGetReady(ctx *middleware.Context, handler GetReadyHandler) *GetReady
  • func (o *GetReady) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetReadyDefault
  • func NewGetReadyDefault(code int) *GetReadyDefault
  • func (o *GetReadyDefault) SetPayload(payload *models.Error)
  • func (o *GetReadyDefault) SetStatusCode(code int)
  • func (o *GetReadyDefault) WithPayload(payload *models.Error) *GetReadyDefault
  • func (o *GetReadyDefault) WithStatusCode(code int) *GetReadyDefault
  • func (o *GetReadyDefault) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetReadyHandler
• type GetReadyHandlerFunc
  • func (fn GetReadyHandlerFunc) Handle(params GetReadyParams) middleware.Responder
• type GetReadyOK
  • func NewGetReadyOK() *GetReadyOK
  • func (o *GetReadyOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetReadyParams
  • func NewGetReadyParams() GetReadyParams
  • func (o *GetReadyParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetReadyServiceUnavailable
  • func NewGetReadyServiceUnavailable() *GetReadyServiceUnavailable
  • func (o *GetReadyServiceUnavailable) SetPayload(payload *models.Error)
  • func (o *GetReadyServiceUnavailable) WithPayload(payload *models.Error) *GetReadyServiceUnavailable
  • func (o *GetReadyServiceUnavailable) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetReadyURL
  • func (o *GetReadyURL) Build() (*url.URL, error)
  • func (o *GetReadyURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetReadyURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetReadyURL) SetBasePath(bp string)
  • func (o *GetReadyURL) String() string
  • func (o *GetReadyURL) StringFull(scheme, host string) string
  • func (o *GetReadyURL) WithBasePath(bp string) *GetReadyURL

Constants

const GetReadyOKCode int = 200

GetReadyOKCode is the HTTP code returned for type GetReadyOK

const GetReadyServiceUnavailableCode int = 503

GetReadyServiceUnavailableCode is the HTTP code returned for type GetReadyServiceUnavailable

Types

type GetReady

type GetReady struct {
	Context *middleware.Context
	Handler GetReadyHandler
}

GetReady swagger:route GET /ready readiness getReady

GetReady get ready API

func NewGetReady

func NewGetReady(ctx *middleware.Context, handler GetReadyHandler) *GetReady

NewGetReady creates a new http.Handler for the get ready operation

func (*GetReady) ServeHTTP

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

type GetReadyDefault

type GetReadyDefault struct {

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

GetReadyDefault generic error response

swagger:response getReadyDefault

func NewGetReadyDefault

func NewGetReadyDefault(code int) *GetReadyDefault

NewGetReadyDefault creates GetReadyDefault with default headers values

func (*GetReadyDefault) SetPayload

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

SetPayload sets the payload to the get ready default response

func (*GetReadyDefault) SetStatusCode

func (o *GetReadyDefault) SetStatusCode(code int)

SetStatusCode sets the status to the get ready default response

func (*GetReadyDefault) WithPayload

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

WithPayload adds the payload to the get ready default response

func (*GetReadyDefault) WithStatusCode

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

WithStatusCode adds the status to the get ready default response

func (*GetReadyDefault) WriteResponse

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

WriteResponse to the client

type GetReadyHandler

type GetReadyHandler interface {
	Handle(GetReadyParams) middleware.Responder
}

GetReadyHandler interface for that can handle valid get ready params

type GetReadyHandlerFunc

type GetReadyHandlerFunc func(GetReadyParams) middleware.Responder

GetReadyHandlerFunc turns a function with the right signature into a get ready handler

func (GetReadyHandlerFunc) Handle

func (fn GetReadyHandlerFunc) Handle(params GetReadyParams) middleware.Responder

Handle executing the request and returning a response

type GetReadyOK

type GetReadyOK struct {
}

GetReadyOK readiness probe

swagger:response getReadyOK

func NewGetReadyOK

func NewGetReadyOK() *GetReadyOK

NewGetReadyOK creates GetReadyOK with default headers values

func (*GetReadyOK) WriteResponse

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

WriteResponse to the client

type GetReadyParams

type GetReadyParams struct {

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

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

swagger:parameters GetReady

func NewGetReadyParams

func NewGetReadyParams() GetReadyParams

NewGetReadyParams creates a new GetReadyParams object no default values defined in spec.

func (*GetReadyParams) BindRequest

func (o *GetReadyParams) 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 NewGetReadyParams() beforehand.

type GetReadyServiceUnavailable

type GetReadyServiceUnavailable struct {

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

GetReadyServiceUnavailable if not ready

swagger:response getReadyServiceUnavailable

func NewGetReadyServiceUnavailable

func NewGetReadyServiceUnavailable() *GetReadyServiceUnavailable

NewGetReadyServiceUnavailable creates GetReadyServiceUnavailable with default headers values

func (*GetReadyServiceUnavailable) SetPayload

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

SetPayload sets the payload to the get ready service unavailable response

func (*GetReadyServiceUnavailable) WithPayload

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

WithPayload adds the payload to the get ready service unavailable response

func (*GetReadyServiceUnavailable) WriteResponse

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

WriteResponse to the client

type GetReadyURL

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

GetReadyURL generates an URL for the get ready operation

func (*GetReadyURL) Build

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

Build a url path and query string

func (*GetReadyURL) BuildFull

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

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

func (*GetReadyURL) Must

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

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

func (*GetReadyURL) SetBasePath

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

func (o *GetReadyURL) String() string

String returns the string representation of the path with query string

func (*GetReadyURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetReadyURL) WithBasePath

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

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