health

Documentation

Index

• Constants
• Variables
• func NewCheckEndpoint(s Service) goa.Endpoint
• type CheckResult
• type Client
  • func NewClient(check goa.Endpoint) *Client
  • func (c *Client) Check(ctx context.Context) (res *CheckResult, err error)
• type Endpoints
  • func NewEndpoints(s Service) *Endpoints
  • func (e *Endpoints) Use(m func(goa.Endpoint) goa.Endpoint)
• type Service

Constants

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

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 {
	// Status of the API
	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 for probes
	Check(context.Context) (res *CheckResult, err error)
}

Provide service health information