streaming

Documentation

Index

• type Connector
• type ListEventsParams
• type QueryParams
  • func (p *QueryParams) Validate(meterWindowSize models.WindowSize) error
• type QueryResult

Types

type Connector

type Connector interface {
	ListEvents(ctx context.Context, namespace string, params ListEventsParams) ([]event.Event, error)
	CreateMeter(ctx context.Context, namespace string, meter *models.Meter) error
	DeleteMeter(ctx context.Context, namespace string, meterSlug string) error
	QueryMeter(ctx context.Context, namespace string, meterSlug string, params *QueryParams) (*QueryResult, error)
	ListMeterSubjects(ctx context.Context, namespace string, meterSlug string, from *time.Time, to *time.Time) ([]string, error)
}

type ListEventsParams

type ListEventsParams struct {
	Limit int
}

type QueryParams

type QueryParams struct {
	From           *time.Time
	To             *time.Time
	Subject        []string
	GroupBySubject bool
	GroupBy        []string
	Aggregation    models.MeterAggregation
	WindowSize     *models.WindowSize
	WindowTimeZone *time.Location
}

func (*QueryParams) Validate

func (p *QueryParams) Validate(meterWindowSize models.WindowSize) error

Validate validates query params focusing on `from` and `to` being aligned with query and meter window sizes

type QueryResult

type QueryResult struct {
	WindowSize *models.WindowSize
	Values     []*models.MeterValue
}