Documentation
¶
Index ¶
- func CheckHealthPath() string
- func DecodeCheckResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)
- func NewCheckResultOK(body *CheckResponseBody) *health.CheckResult
- func ValidateCheckResponseBody(body *CheckResponseBody) (err error)
- type CheckResponseBody
- type Client
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CheckHealthPath ¶
func CheckHealthPath() string
CheckHealthPath returns the URL path to the health service check HTTP endpoint.
func DecodeCheckResponse ¶
func DecodeCheckResponse(decoder func(*http.Response) goahttp.Decoder, restoreBody bool) func(*http.Response) (any, error)
DecodeCheckResponse returns a decoder for responses returned by the health check endpoint. restoreBody controls whether the response body should be restored after having been read.
func NewCheckResultOK ¶
func NewCheckResultOK(body *CheckResponseBody) *health.CheckResult
NewCheckResultOK builds a "health" service "check" endpoint result from a HTTP "OK" response.
func ValidateCheckResponseBody ¶
func ValidateCheckResponseBody(body *CheckResponseBody) (err error)
ValidateCheckResponseBody runs the validations defined on CheckResponseBody
Types ¶
type CheckResponseBody ¶
type CheckResponseBody struct {
// Health status
Status *string `form:"status,omitempty" json:"status,omitempty" xml:"status,omitempty"`
}
CheckResponseBody is the type of the "health" service "check" endpoint HTTP response body.
type Client ¶
type Client struct {
// Check Doer is the HTTP client used to make requests to the check endpoint.
CheckDoer goahttp.Doer
// RestoreResponseBody controls whether the response bodies are reset after
// decoding so they can be read again.
RestoreResponseBody bool
// contains filtered or unexported fields
}
Client lists the health service endpoint HTTP clients.
func NewClient ¶
func NewClient( scheme string, host string, doer goahttp.Doer, enc func(*http.Request) goahttp.Encoder, dec func(*http.Response) goahttp.Decoder, restoreBody bool, ) *Client
NewClient instantiates HTTP clients for all the health service servers.
func (*Client) BuildCheckRequest ¶
BuildCheckRequest instantiates a HTTP request object with method and path set to call the "health" service "check" endpoint
Source Files