message

Documentation

Index

• Constants
• func HumanReadable(nm *v1alpha1.NotifyMaintenance, event MessageEvent) string
• func MachineReadable(nm *v1alpha1.NotifyMaintenance, event MessageEvent) (string, error)
• type Message
• type MessageEvent

Constants

const (
	MessageEventScheduled             = MessageEvent("Scheduled")
	MessageEventSLAStarted            = MessageEvent("SLAStarted")
	MessageEventSLAExpired            = MessageEvent("SLAExpired")
	MessageEventObjectsDrained        = MessageEvent("ObjectsDrained")
	MessageEventValidating            = MessageEvent("Validating")
	MessageEventMaintenanceIncomplete = MessageEvent("MaintenanceIncomplete")
	MessageEventMaintenanceComplete   = MessageEvent("MaintenanceComplete")
	MessageEventMaintenanceEnded      = MessageEvent("MaintenanceEnded")
	MessageEventMaintenanceCancelled  = MessageEvent("MaintenanceCancelled")
)

Functions

func HumanReadable

func HumanReadable(nm *v1alpha1.NotifyMaintenance, event MessageEvent) string

HumanReadable returns a human-readable string from the nm objects and the event that triggered this message

func MachineReadable

func MachineReadable(nm *v1alpha1.NotifyMaintenance, event MessageEvent) (string, error)

MachineReadable returns a json string from the nm objects and the event that triggered this message

Types

type Message

type Message struct {
	MaintenanceID               string       `json:"maintenanceID"`
	Objects                     []string     `json:"objects"`
	Event                       MessageEvent `json:"event"`
	Message                     string       `json:"Message,omitempty"`
	Namespace                   string       `json:"namespace"`
	MaintenanceObjectName       string       `json:"maintenanceObjectName"`
	MetadataConfigmap           string       `json:"metadataConfigmap,omitempty"`
	ValidationMetadataOverrides string       `json:"validationMetadataOverrides,omitempty"`
	Owner                       string       `json:"owner,omitempty"`
}

type MessageEvent

type MessageEvent string