jetbrainsspace

Documentation

Index

• type Accessory
• type AlertProvider
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, ...) error
• type Body
• type Content
• type Element
• type Icon
• type Override
• type Section

Types

type Accessory

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

type AlertProvider

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

	// 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) GetDefaultAlert

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

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

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

Send an alert using the provider

type Body

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

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"`
	ChannelID string `yaml:"channel-id"`
}

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"`
}