status

Documentation

Index

• Constants
• type Client
  • func New(wectx config.Context) *Client
  • func (c *Client) IsUp(ctx context.Context) bool
  • func (c *Client) UnsafeGet(ctx context.Context) (s Status, err error)
• type Domains
• type Status

Constants

const (
	// Up status
	Up = "up"

	// Down status
	Down = "down"
)

Types

type Client

type Client struct {
	*apihelper.Client
}

Client for the services

func New

func New(wectx config.Context) *Client

New Client

func (*Client) IsUp

func (c *Client) IsUp(ctx context.Context) bool

IsUp is returned if the infrastructure is up

func (*Client) UnsafeGet

func (c *Client) UnsafeGet(ctx context.Context) (s Status, err error)

UnsafeGet is a unsafe getter for the status See get() method below to understand why. It is exported here to use for domains.

type Domains

type Domains struct {
	Infrastructure string `json:"infrastructure"`
	Service        string `json:"service"`
}

Domains of the infrastructure

type Status

type Status struct {
	Status  string  `json:"status"`
	Version string  `json:"version"`
	Domains Domains `json:"domains"`
}

Status of the Backend