health

package
v0.0.0-...-625d9dc Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 26, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const APIVersionOKCode int = 200

APIVersionOKCode is the HTTP code returned for type APIVersionOK

View Source
const GetMetricsOKCode int = 200

GetMetricsOKCode is the HTTP code returned for type GetMetricsOK

View Source
const HealthAliveOKCode int = 200

HealthAliveOKCode is the HTTP code returned for type HealthAliveOK

View Source
const HealthReadyOKCode int = 200

HealthReadyOKCode is the HTTP code returned for type HealthReadyOK

Variables

This section is empty.

Functions

This section is empty.

Types

type APIVersion

type APIVersion struct {
	Context *middleware.Context
	Handler APIVersionHandler
}
APIVersion swagger:route GET /api/v1/version health apiVersion

Get app version

Shows api version.

func NewAPIVersion

func NewAPIVersion(ctx *middleware.Context, handler APIVersionHandler) *APIVersion

NewAPIVersion creates a new http.Handler for the api version operation

func (*APIVersion) ServeHTTP

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

type APIVersionDefault

type APIVersionDefault struct {

	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

APIVersionDefault unexpected error

swagger:response apiVersionDefault

func NewAPIVersionDefault

func NewAPIVersionDefault(code int) *APIVersionDefault

NewAPIVersionDefault creates APIVersionDefault with default headers values

func (*APIVersionDefault) SetPayload

func (o *APIVersionDefault) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the api version default response

func (*APIVersionDefault) SetStatusCode

func (o *APIVersionDefault) SetStatusCode(code int)

SetStatusCode sets the status to the api version default response

func (*APIVersionDefault) SetXRequestID

func (o *APIVersionDefault) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the api version default response

func (*APIVersionDefault) WithPayload

func (o *APIVersionDefault) WithPayload(payload *models.ErrorResponse) *APIVersionDefault

WithPayload adds the payload to the api version default response

func (*APIVersionDefault) WithStatusCode

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

WithStatusCode adds the status to the api version default response

func (*APIVersionDefault) WithXRequestID

func (o *APIVersionDefault) WithXRequestID(xRequestID string) *APIVersionDefault

WithXRequestID adds the xRequestId to the api version default response

func (*APIVersionDefault) WriteResponse

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

WriteResponse to the client

type APIVersionHandler

type APIVersionHandler interface {
	Handle(APIVersionParams) middleware.Responder
}

APIVersionHandler interface for that can handle valid api version params

type APIVersionHandlerFunc

type APIVersionHandlerFunc func(APIVersionParams) middleware.Responder

APIVersionHandlerFunc turns a function with the right signature into a api version handler

func (APIVersionHandlerFunc) Handle

Handle executing the request and returning a response

type APIVersionOK

type APIVersionOK struct {
	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

APIVersionOK version info

swagger:response apiVersionOK

func NewAPIVersionOK

func NewAPIVersionOK() *APIVersionOK

NewAPIVersionOK creates APIVersionOK with default headers values

func (*APIVersionOK) SetPayload

func (o *APIVersionOK) SetPayload(payload *models.APIVersion)

SetPayload sets the payload to the api version o k response

func (*APIVersionOK) SetXRequestID

func (o *APIVersionOK) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the api version o k response

func (*APIVersionOK) WithPayload

func (o *APIVersionOK) WithPayload(payload *models.APIVersion) *APIVersionOK

WithPayload adds the payload to the api version o k response

func (*APIVersionOK) WithXRequestID

func (o *APIVersionOK) WithXRequestID(xRequestID string) *APIVersionOK

WithXRequestID adds the xRequestId to the api version o k response

func (*APIVersionOK) WriteResponse

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

WriteResponse to the client

type APIVersionParams

type APIVersionParams struct {

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

APIVersionParams contains all the bound params for the api version operation typically these are obtained from a http.Request

swagger:parameters apiVersion

func NewAPIVersionParams

func NewAPIVersionParams() APIVersionParams

NewAPIVersionParams creates a new APIVersionParams object

There are no default values defined in the spec.

func (*APIVersionParams) BindRequest

func (o *APIVersionParams) 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 NewAPIVersionParams() beforehand.

type APIVersionURL

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

APIVersionURL generates an URL for the api version operation

func (*APIVersionURL) Build

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

Build a url path and query string

func (*APIVersionURL) BuildFull

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

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

func (*APIVersionURL) Must

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

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

func (*APIVersionURL) SetBasePath

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

func (o *APIVersionURL) String() string

String returns the string representation of the path with query string

func (*APIVersionURL) StringFull

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

StringFull returns the string representation of a complete url

func (*APIVersionURL) WithBasePath

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

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 GetMetrics

type GetMetrics struct {
	Context *middleware.Context
	Handler GetMetricsHandler
}
GetMetrics swagger:route GET /metrics health getMetrics

Prometheus metrics

func NewGetMetrics

func NewGetMetrics(ctx *middleware.Context, handler GetMetricsHandler) *GetMetrics

NewGetMetrics creates a new http.Handler for the get metrics operation

func (*GetMetrics) ServeHTTP

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

type GetMetricsHandler

type GetMetricsHandler interface {
	Handle(GetMetricsParams) middleware.Responder
}

GetMetricsHandler interface for that can handle valid get metrics params

type GetMetricsHandlerFunc

type GetMetricsHandlerFunc func(GetMetricsParams) middleware.Responder

GetMetricsHandlerFunc turns a function with the right signature into a get metrics handler

func (GetMetricsHandlerFunc) Handle

Handle executing the request and returning a response

type GetMetricsOK

type GetMetricsOK struct {

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

GetMetricsOK ok

swagger:response getMetricsOK

func NewGetMetricsOK

func NewGetMetricsOK() *GetMetricsOK

NewGetMetricsOK creates GetMetricsOK with default headers values

func (*GetMetricsOK) SetPayload

func (o *GetMetricsOK) SetPayload(payload string)

SetPayload sets the payload to the get metrics o k response

func (*GetMetricsOK) WithPayload

func (o *GetMetricsOK) WithPayload(payload string) *GetMetricsOK

WithPayload adds the payload to the get metrics o k response

func (*GetMetricsOK) WriteResponse

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

WriteResponse to the client

type GetMetricsParams

type GetMetricsParams struct {

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

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

swagger:parameters GetMetrics

func NewGetMetricsParams

func NewGetMetricsParams() GetMetricsParams

NewGetMetricsParams creates a new GetMetricsParams object

There are no default values defined in the spec.

func (*GetMetricsParams) BindRequest

func (o *GetMetricsParams) 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 NewGetMetricsParams() beforehand.

type GetMetricsURL

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

GetMetricsURL generates an URL for the get metrics operation

func (*GetMetricsURL) Build

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

Build a url path and query string

func (*GetMetricsURL) BuildFull

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

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

func (*GetMetricsURL) Must

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

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

func (*GetMetricsURL) SetBasePath

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

func (o *GetMetricsURL) String() string

String returns the string representation of the path with query string

func (*GetMetricsURL) StringFull

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

StringFull returns the string representation of a complete url

func (*GetMetricsURL) WithBasePath

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

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 HealthAlive

type HealthAlive struct {
	Context *middleware.Context
	Handler HealthAliveHandler
}
HealthAlive swagger:route GET /health/live health healthAlive

Probe service alive

Checks web service is working

func NewHealthAlive

func NewHealthAlive(ctx *middleware.Context, handler HealthAliveHandler) *HealthAlive

NewHealthAlive creates a new http.Handler for the health alive operation

func (*HealthAlive) ServeHTTP

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

type HealthAliveDefault

type HealthAliveDefault struct {

	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

HealthAliveDefault unexpected error

swagger:response healthAliveDefault

func NewHealthAliveDefault

func NewHealthAliveDefault(code int) *HealthAliveDefault

NewHealthAliveDefault creates HealthAliveDefault with default headers values

func (*HealthAliveDefault) SetPayload

func (o *HealthAliveDefault) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the health alive default response

func (*HealthAliveDefault) SetStatusCode

func (o *HealthAliveDefault) SetStatusCode(code int)

SetStatusCode sets the status to the health alive default response

func (*HealthAliveDefault) SetXRequestID

func (o *HealthAliveDefault) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the health alive default response

func (*HealthAliveDefault) WithPayload

func (o *HealthAliveDefault) WithPayload(payload *models.ErrorResponse) *HealthAliveDefault

WithPayload adds the payload to the health alive default response

func (*HealthAliveDefault) WithStatusCode

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

WithStatusCode adds the status to the health alive default response

func (*HealthAliveDefault) WithXRequestID

func (o *HealthAliveDefault) WithXRequestID(xRequestID string) *HealthAliveDefault

WithXRequestID adds the xRequestId to the health alive default response

func (*HealthAliveDefault) WriteResponse

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

WriteResponse to the client

type HealthAliveHandler

type HealthAliveHandler interface {
	Handle(HealthAliveParams) middleware.Responder
}

HealthAliveHandler interface for that can handle valid health alive params

type HealthAliveHandlerFunc

type HealthAliveHandlerFunc func(HealthAliveParams) middleware.Responder

HealthAliveHandlerFunc turns a function with the right signature into a health alive handler

func (HealthAliveHandlerFunc) Handle

Handle executing the request and returning a response

type HealthAliveOK

type HealthAliveOK struct {
	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

HealthAliveOK successful operation, service alive

swagger:response healthAliveOK

func NewHealthAliveOK

func NewHealthAliveOK() *HealthAliveOK

NewHealthAliveOK creates HealthAliveOK with default headers values

func (*HealthAliveOK) SetPayload

func (o *HealthAliveOK) SetPayload(payload string)

SetPayload sets the payload to the health alive o k response

func (*HealthAliveOK) SetXRequestID

func (o *HealthAliveOK) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the health alive o k response

func (*HealthAliveOK) WithPayload

func (o *HealthAliveOK) WithPayload(payload string) *HealthAliveOK

WithPayload adds the payload to the health alive o k response

func (*HealthAliveOK) WithXRequestID

func (o *HealthAliveOK) WithXRequestID(xRequestID string) *HealthAliveOK

WithXRequestID adds the xRequestId to the health alive o k response

func (*HealthAliveOK) WriteResponse

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

WriteResponse to the client

type HealthAliveParams

type HealthAliveParams struct {

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

HealthAliveParams contains all the bound params for the health alive operation typically these are obtained from a http.Request

swagger:parameters healthAlive

func NewHealthAliveParams

func NewHealthAliveParams() HealthAliveParams

NewHealthAliveParams creates a new HealthAliveParams object

There are no default values defined in the spec.

func (*HealthAliveParams) BindRequest

func (o *HealthAliveParams) 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 NewHealthAliveParams() beforehand.

type HealthAliveURL

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

HealthAliveURL generates an URL for the health alive operation

func (*HealthAliveURL) Build

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

Build a url path and query string

func (*HealthAliveURL) BuildFull

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

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

func (*HealthAliveURL) Must

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

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

func (*HealthAliveURL) SetBasePath

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

func (o *HealthAliveURL) String() string

String returns the string representation of the path with query string

func (*HealthAliveURL) StringFull

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

StringFull returns the string representation of a complete url

func (*HealthAliveURL) WithBasePath

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

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 HealthReady

type HealthReady struct {
	Context *middleware.Context
	Handler HealthReadyHandler
}
HealthReady swagger:route GET /health/ready health healthReady

Probe service ready

Checks web service is working, and subservices available

func NewHealthReady

func NewHealthReady(ctx *middleware.Context, handler HealthReadyHandler) *HealthReady

NewHealthReady creates a new http.Handler for the health ready operation

func (*HealthReady) ServeHTTP

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

type HealthReadyDefault

type HealthReadyDefault struct {

	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

HealthReadyDefault unexpected error

swagger:response healthReadyDefault

func NewHealthReadyDefault

func NewHealthReadyDefault(code int) *HealthReadyDefault

NewHealthReadyDefault creates HealthReadyDefault with default headers values

func (*HealthReadyDefault) SetPayload

func (o *HealthReadyDefault) SetPayload(payload *models.ErrorResponse)

SetPayload sets the payload to the health ready default response

func (*HealthReadyDefault) SetStatusCode

func (o *HealthReadyDefault) SetStatusCode(code int)

SetStatusCode sets the status to the health ready default response

func (*HealthReadyDefault) SetXRequestID

func (o *HealthReadyDefault) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the health ready default response

func (*HealthReadyDefault) WithPayload

func (o *HealthReadyDefault) WithPayload(payload *models.ErrorResponse) *HealthReadyDefault

WithPayload adds the payload to the health ready default response

func (*HealthReadyDefault) WithStatusCode

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

WithStatusCode adds the status to the health ready default response

func (*HealthReadyDefault) WithXRequestID

func (o *HealthReadyDefault) WithXRequestID(xRequestID string) *HealthReadyDefault

WithXRequestID adds the xRequestId to the health ready default response

func (*HealthReadyDefault) WriteResponse

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

WriteResponse to the client

type HealthReadyHandler

type HealthReadyHandler interface {
	Handle(HealthReadyParams) middleware.Responder
}

HealthReadyHandler interface for that can handle valid health ready params

type HealthReadyHandlerFunc

type HealthReadyHandlerFunc func(HealthReadyParams) middleware.Responder

HealthReadyHandlerFunc turns a function with the right signature into a health ready handler

func (HealthReadyHandlerFunc) Handle

Handle executing the request and returning a response

type HealthReadyOK

type HealthReadyOK struct {
	/*The request id this is a response to

	 */
	XRequestID string `json:"X-Request-Id"`

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

HealthReadyOK successful operation, service ready to process requests

swagger:response healthReadyOK

func NewHealthReadyOK

func NewHealthReadyOK() *HealthReadyOK

NewHealthReadyOK creates HealthReadyOK with default headers values

func (*HealthReadyOK) SetPayload

func (o *HealthReadyOK) SetPayload(payload string)

SetPayload sets the payload to the health ready o k response

func (*HealthReadyOK) SetXRequestID

func (o *HealthReadyOK) SetXRequestID(xRequestID string)

SetXRequestID sets the xRequestId to the health ready o k response

func (*HealthReadyOK) WithPayload

func (o *HealthReadyOK) WithPayload(payload string) *HealthReadyOK

WithPayload adds the payload to the health ready o k response

func (*HealthReadyOK) WithXRequestID

func (o *HealthReadyOK) WithXRequestID(xRequestID string) *HealthReadyOK

WithXRequestID adds the xRequestId to the health ready o k response

func (*HealthReadyOK) WriteResponse

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

WriteResponse to the client

type HealthReadyParams

type HealthReadyParams struct {

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

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

swagger:parameters healthReady

func NewHealthReadyParams

func NewHealthReadyParams() HealthReadyParams

NewHealthReadyParams creates a new HealthReadyParams object

There are no default values defined in the spec.

func (*HealthReadyParams) BindRequest

func (o *HealthReadyParams) 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 NewHealthReadyParams() beforehand.

type HealthReadyURL

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

HealthReadyURL generates an URL for the health ready operation

func (*HealthReadyURL) Build

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

Build a url path and query string

func (*HealthReadyURL) BuildFull

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

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

func (*HealthReadyURL) Must

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

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

func (*HealthReadyURL) SetBasePath

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

func (o *HealthReadyURL) String() string

String returns the string representation of the path with query string

func (*HealthReadyURL) StringFull

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

StringFull returns the string representation of a complete url

func (*HealthReadyURL) WithBasePath

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

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL