kubernetes

Documentation

Index

• Constants
• type GetHealthz
  • func NewGetHealthz(ctx *middleware.Context, handler GetHealthzHandler) *GetHealthz
  • func (o *GetHealthz) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetHealthzHandler
• type GetHealthzHandlerFunc
  • func (fn GetHealthzHandlerFunc) Handle(params GetHealthzParams) middleware.Responder
• type GetHealthzOK
  • func NewGetHealthzOK() *GetHealthzOK
  • func (o *GetHealthzOK) SetPayload(payload interface{})
  • func (o *GetHealthzOK) WithPayload(payload interface{}) *GetHealthzOK
  • func (o *GetHealthzOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetHealthzParams
  • func NewGetHealthzParams() GetHealthzParams
  • func (o *GetHealthzParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetHealthzURL
  • func (o *GetHealthzURL) Build() (*url.URL, error)
  • func (o *GetHealthzURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetHealthzURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetHealthzURL) SetBasePath(bp string)
  • func (o *GetHealthzURL) String() string
  • func (o *GetHealthzURL) StringFull(scheme, host string) string
  • func (o *GetHealthzURL) WithBasePath(bp string) *GetHealthzURL
• type GetReadyz
  • func NewGetReadyz(ctx *middleware.Context, handler GetReadyzHandler) *GetReadyz
  • func (o *GetReadyz) ServeHTTP(rw http.ResponseWriter, r *http.Request)
• type GetReadyzHandler
• type GetReadyzHandlerFunc
  • func (fn GetReadyzHandlerFunc) Handle(params GetReadyzParams) middleware.Responder
• type GetReadyzOK
  • func NewGetReadyzOK() *GetReadyzOK
  • func (o *GetReadyzOK) SetPayload(payload interface{})
  • func (o *GetReadyzOK) WithPayload(payload interface{}) *GetReadyzOK
  • func (o *GetReadyzOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer)
• type GetReadyzParams
  • func NewGetReadyzParams() GetReadyzParams
  • func (o *GetReadyzParams) BindRequest(r *http.Request, route *middleware.MatchedRoute) error
• type GetReadyzURL
  • func (o *GetReadyzURL) Build() (*url.URL, error)
  • func (o *GetReadyzURL) BuildFull(scheme, host string) (*url.URL, error)
  • func (o *GetReadyzURL) Must(u *url.URL, err error) *url.URL
  • func (o *GetReadyzURL) SetBasePath(bp string)
  • func (o *GetReadyzURL) String() string
  • func (o *GetReadyzURL) StringFull(scheme, host string) string
  • func (o *GetReadyzURL) WithBasePath(bp string) *GetReadyzURL

Constants

const GetHealthzOKCode int = 200

GetHealthzOKCode is the HTTP code returned for type GetHealthzOK

const GetReadyzOKCode int = 200

GetReadyzOKCode is the HTTP code returned for type GetReadyzOK

Types

type GetHealthz

type GetHealthz struct {
	Context *middleware.Context
	Handler GetHealthzHandler
}

GetHealthz swagger:route GET /healthz Kubernetes getHealthz

Liveness check

used by Kubernetes liveness probe

func NewGetHealthz

func NewGetHealthz(ctx *middleware.Context, handler GetHealthzHandler) *GetHealthz

NewGetHealthz creates a new http.Handler for the get healthz operation

func (*GetHealthz) ServeHTTP

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

type GetHealthzHandler

type GetHealthzHandler interface {
	Handle(GetHealthzParams) middleware.Responder
}

GetHealthzHandler interface for that can handle valid get healthz params

type GetHealthzHandlerFunc

type GetHealthzHandlerFunc func(GetHealthzParams) middleware.Responder

GetHealthzHandlerFunc turns a function with the right signature into a get healthz handler

func (GetHealthzHandlerFunc) Handle

func (fn GetHealthzHandlerFunc) Handle(params GetHealthzParams) middleware.Responder

Handle executing the request and returning a response

type GetHealthzOK

type GetHealthzOK struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

GetHealthzOK OK

swagger:response getHealthzOK

func NewGetHealthzOK

func NewGetHealthzOK() *GetHealthzOK

NewGetHealthzOK creates GetHealthzOK with default headers values

func (*GetHealthzOK) SetPayload

func (o *GetHealthzOK) SetPayload(payload interface{})

SetPayload sets the payload to the get healthz o k response

func (*GetHealthzOK) WithPayload

func (o *GetHealthzOK) WithPayload(payload interface{}) *GetHealthzOK

WithPayload adds the payload to the get healthz o k response

func (*GetHealthzOK) WriteResponse

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

WriteResponse to the client

type GetHealthzParams

type GetHealthzParams struct {

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

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

swagger:parameters GetHealthz

func NewGetHealthzParams

func NewGetHealthzParams() GetHealthzParams

NewGetHealthzParams creates a new GetHealthzParams object

There are no default values defined in the spec.

func (*GetHealthzParams) BindRequest

func (o *GetHealthzParams) 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 NewGetHealthzParams() beforehand.

type GetHealthzURL

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

GetHealthzURL generates an URL for the get healthz operation

func (*GetHealthzURL) Build

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

Build a url path and query string

func (*GetHealthzURL) BuildFull

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

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

func (*GetHealthzURL) Must

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

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

func (*GetHealthzURL) SetBasePath

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

func (o *GetHealthzURL) String() string

String returns the string representation of the path with query string

func (*GetHealthzURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetHealthzURL) WithBasePath

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

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 GetReadyz

type GetReadyz struct {
	Context *middleware.Context
	Handler GetReadyzHandler
}

GetReadyz swagger:route GET /readyz Kubernetes getReadyz

Readiness check

used by Kubernetes readiness probe

func NewGetReadyz

func NewGetReadyz(ctx *middleware.Context, handler GetReadyzHandler) *GetReadyz

NewGetReadyz creates a new http.Handler for the get readyz operation

func (*GetReadyz) ServeHTTP

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

type GetReadyzHandler

type GetReadyzHandler interface {
	Handle(GetReadyzParams) middleware.Responder
}

GetReadyzHandler interface for that can handle valid get readyz params

type GetReadyzHandlerFunc

type GetReadyzHandlerFunc func(GetReadyzParams) middleware.Responder

GetReadyzHandlerFunc turns a function with the right signature into a get readyz handler

func (GetReadyzHandlerFunc) Handle

func (fn GetReadyzHandlerFunc) Handle(params GetReadyzParams) middleware.Responder

Handle executing the request and returning a response

type GetReadyzOK

type GetReadyzOK struct {

	/*
	  In: Body
	*/
	Payload interface{} `json:"body,omitempty"`
}

GetReadyzOK OK

swagger:response getReadyzOK

func NewGetReadyzOK

func NewGetReadyzOK() *GetReadyzOK

NewGetReadyzOK creates GetReadyzOK with default headers values

func (*GetReadyzOK) SetPayload

func (o *GetReadyzOK) SetPayload(payload interface{})

SetPayload sets the payload to the get readyz o k response

func (*GetReadyzOK) WithPayload

func (o *GetReadyzOK) WithPayload(payload interface{}) *GetReadyzOK

WithPayload adds the payload to the get readyz o k response

func (*GetReadyzOK) WriteResponse

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

WriteResponse to the client

type GetReadyzParams

type GetReadyzParams struct {

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

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

swagger:parameters GetReadyz

func NewGetReadyzParams

func NewGetReadyzParams() GetReadyzParams

NewGetReadyzParams creates a new GetReadyzParams object

There are no default values defined in the spec.

func (*GetReadyzParams) BindRequest

func (o *GetReadyzParams) 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 NewGetReadyzParams() beforehand.

type GetReadyzURL

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

GetReadyzURL generates an URL for the get readyz operation

func (*GetReadyzURL) Build

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

Build a url path and query string

func (*GetReadyzURL) BuildFull

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

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

func (*GetReadyzURL) Must

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

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

func (*GetReadyzURL) SetBasePath

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

func (o *GetReadyzURL) String() string

String returns the string representation of the path with query string

func (*GetReadyzURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetReadyzURL) WithBasePath

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

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