jetbrainsspace

Documentation

Index

• Variables
• type Accessory
• type AlertProvider
  • func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, ...) error
  • func (provider *AlertProvider) Validate() error
  • func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error
• type Body
• type Config
  • func (cfg *Config) Merge(override *Config)
  • func (cfg *Config) Validate() error
• type Content
• type Element
• type Icon
• type Override
• type Section

Variables

var (
	ErrProjectNotSet          = errors.New("project not set")
	ErrChannelIDNotSet        = errors.New("channel-id not set")
	ErrTokenNotSet            = errors.New("token not set")
	ErrDuplicateGroupOverride = errors.New("duplicate group override")
)

Types

type Accessory

type Accessory struct {
	ClassName string `json:"className"`
	Icon      Icon   `json:"icon"`
	Style     string `json:"style"`
}

type AlertProvider

type AlertProvider struct {
	DefaultConfig Config `yaml:",inline"`

	// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
	DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"`

	// Overrides is a list of Override that may be prioritized over the default configuration
	Overrides []Override `yaml:"overrides,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using JetBrains Space

func (*AlertProvider) GetConfig

func (provider *AlertProvider) GetConfig(group string, alert *alert.Alert) (*Config, error)

GetConfig returns the configuration for the provider with the overrides applied

func (*AlertProvider) GetDefaultAlert

func (provider *AlertProvider) GetDefaultAlert() *alert.Alert

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) Send

func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error

Send an alert using the provider

func (*AlertProvider) Validate

func (provider *AlertProvider) Validate() error

Validate the provider's configuration

func (*AlertProvider) ValidateOverrides

func (provider *AlertProvider) ValidateOverrides(group string, alert *alert.Alert) error

ValidateOverrides validates the alert's provider override and, if present, the group override

type Body

type Body struct {
	Channel string  `json:"channel"`
	Content Content `json:"content"`
}

type Config

type Config struct {
	Project   string `yaml:"project"`    // Project name
	ChannelID string `yaml:"channel-id"` // Chat Channel ID
	Token     string `yaml:"token"`      // Bearer Token
}

func (*Config) Merge

func (cfg *Config) Merge(override *Config)

func (*Config) Validate

func (cfg *Config) Validate() error

type Content

type Content struct {
	ClassName string    `json:"className"`
	Style     string    `json:"style"`
	Sections  []Section `json:"sections,omitempty"`
}

type Element

type Element struct {
	ClassName string    `json:"className"`
	Accessory Accessory `json:"accessory"`
	Style     string    `json:"style"`
	Size      string    `json:"size"`
	Content   string    `json:"content"`
}

type Icon

type Icon struct {
	Icon string `json:"icon"`
}

type Override

type Override struct {
	Group  string `yaml:"group"`
	Config `yaml:",inline"`
}

Override is a case under which the default integration is overridden

type Section

type Section struct {
	ClassName string    `json:"className"`
	Elements  []Element `json:"elements"`
	Header    string    `json:"header"`
}