health

package
v0.3.0 Latest Latest
Warning

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

 Go to latest Published: Aug 25, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source 
const APIName = "kube-workspaces"

APIName is the name of the API as defined in the design.

View Source 
const APIVersion = "1.0.0"

APIVersion is the version of the API as defined in the design.

View Source 
const ServiceName = "health"

ServiceName is the name of the service as defined in the design. This is the same value that is set in the endpoint request contexts under the ServiceKey key.

Variables

View Source 
var MethodNames = [1]string{"check"}

MethodNames lists the service method names as defined in the design. These are the same values that are set in the endpoint request contexts under the MethodKey key.

Functions

func NewCheckEndpoint 

func NewCheckEndpoint(s Service) goa.Endpoint

NewCheckEndpoint returns an endpoint function that calls the method "check" of service "health".

Types

type CheckResult 

type CheckResult struct {
	// Health status
	Status string
}

CheckResult is the result type of the health service check method.

type Client 

type Client struct {
	CheckEndpoint goa.Endpoint
}

Client is the "health" service client.

func NewClient 

func NewClient(check goa.Endpoint) *Client

NewClient initializes a "health" service client given the endpoints.

func (*Client) Check 

func (c *Client) Check(ctx context.Context) (res *CheckResult, err error)

Check calls the "check" endpoint of the "health" service.

type Endpoints 

type Endpoints struct {
	Check goa.Endpoint
}

Endpoints wraps the "health" service endpoints.

func NewEndpoints 

func NewEndpoints(s Service) *Endpoints

NewEndpoints wraps the methods of the "health" service with endpoints.

func (*Endpoints) Use 

func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)

Use applies the given middleware to all the "health" service endpoints.

type Service 

type Service interface {
	// Health check endpoint
	Check(context.Context) (res *CheckResult, err error)
}

Health check service

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.