notification

package

v0.51.0 Latest Latest Go to latest Published: Oct 26, 2026 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Kong/volcano-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package notification performs the project notification settings workflows behind the volcano notifications subcommands.

Index ¶

Constants
func NotifyOnValues() []string
type Service
- func NewService(deps cliruntime.Deps) Service
type Update
- func (u Update) Empty() bool
- func (u Update) Validate() error

Constants ¶

View Source

const (
	NotifyOnFirstFailure        = string(apiclient.SchedulerFailureNotifyOnFirstFailure)
	NotifyOnConsecutiveFailures = string(apiclient.SchedulerFailureNotifyOnConsecutiveFailures)
)

When a failing scheduler is announced.

View Source

const (
	MinThreshold = 1
	MaxThreshold = 100
)

Threshold bounds, as the API enforces them.

View Source

const MaxRecipients = 10

MaxRecipients is the most email recipients the API accepts.

Variables ¶

This section is empty.

Functions ¶

func NotifyOnValues ¶

func NotifyOnValues() []string

NotifyOnValues lists the accepted --notify-on values.

Types ¶

type Service ¶

type Service struct {
	// contains filtered or unexported fields
}

Service performs notification settings workflows against the current project.

func NewService ¶

func NewService(deps cliruntime.Deps) Service

NewService returns a notification settings service.

func (Service) Get ¶

func (s Service) Get(ctx context.Context) (*apiclient.NotificationSettings, error)

Get returns the current project's notification settings.

func (Service) RotateWebhookSecret ¶

func (s Service) RotateWebhookSecret(ctx context.Context) (*apiclient.NotificationSettings, error)

RotateWebhookSecret replaces the current project's webhook signing secret.

func (Service) SendTest ¶

func (s Service) SendTest(ctx context.Context) (*apiclient.NotificationTestResult, error)

SendTest sends a test notification on every channel the current project has configured.

func (Service) Update ¶

func (s Service) Update(ctx context.Context, update Update) (*apiclient.NotificationSettings, error)

Update applies update to the current project's notification settings.

type Update ¶

type Update struct {
	EmailEnabled     *bool
	Recipients       *[]string
	WebhookURL       *string
	NotifyOn         *string
	Threshold        *int
	NotifyOnRecovery *bool
}

Update is a settings change. A nil field keeps its current value.

func (Update) Empty ¶

func (u Update) Empty() bool

Empty reports whether u changes nothing.

func (Update) Validate ¶

func (u Update) Validate() error

Validate refuses what the API would, before the request is sent.

Source Files ¶

View all Source files

notification.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL