api

Documentation

Index

• type SystemBanner
• type SystemBannerManager
• type SystemBannerSeverity
  • func GetSeverity(severity string) SystemBannerSeverity

Types

type SystemBanner

type SystemBanner struct {
	Message  string               `json:"message"`
	Severity SystemBannerSeverity `json:"severity"`
}

SystemBanner represents system banner.

type SystemBannerManager

type SystemBannerManager interface {
	// Get system banner.
	Get() *SystemBanner
}

SystemBannerManager is used for user system banner management.

type SystemBannerSeverity

type SystemBannerSeverity string

SystemBannerSeverity represents severity of system banner.

const (
	// SystemBannerSeverityInfo is the lowest of allowed system banner severities.
	SystemBannerSeverityInfo SystemBannerSeverity = "INFO"

	// SystemBannerSeverityInfo is in the middle of allowed system banner severities.
	SystemBannerSeverityWarning SystemBannerSeverity = "WARNING"

	// SystemBannerSeverityInfo is the highest of allowed system banner severities.
	SystemBannerSeverityError SystemBannerSeverity = "ERROR"
)

func GetSeverity

func GetSeverity(severity string) SystemBannerSeverity

GetSeverity returns one of allowed severity values based on given parameter.