backend

Documentation

Index

• func AddEventService(ws *restful.WebService, es EventSource)
• func WebService(event EventSource) *restful.WebService
• func WithListOptionsParam(builder *restful.RouteBuilder) *restful.RouteBuilder
• type Event
• type EventList
• type EventMetrics
• type EventSource
• type EventType
• type ListOptions
  • func ListOptionsFromRequest(req *restful.Request) (opts ListOptions, err error)

Functions

func AddEventService

func AddEventService(ws *restful.WebService, es EventSource)

func WebService

func WebService(event EventSource) *restful.WebService

func WithListOptionsParam

func WithListOptionsParam(builder *restful.RouteBuilder) *restful.RouteBuilder

Types

type Event

type Event struct {
	// Name of event, it should be shown on dashboard
	Name string `json:"name"`
	// Type of event. All events can be grouped by the type.
	Type EventType `json:"type"`
	// Metrics is the metrical data about this event
	Metrics EventMetrics `json:"metrics"`
}

type EventList

type EventList struct {
	Items []Event `json:"items"`
}

type EventMetrics

type EventMetrics struct {
	Count int64 `json:"count"`
}

type EventSource

type EventSource interface {
	ListEvent(ctx context.Context, opts ListOptions) (EventList, error)
}

type EventType

type EventType string

type ListOptions

type ListOptions struct {
	Limit  int64
	Offset int64
	Filter string
}

func ListOptionsFromRequest

func ListOptionsFromRequest(req *restful.Request) (opts ListOptions, err error)