keyed

Documentation

Overview

Package keyed implements KeyedWindows. A keyed window associates key(s) with a window. A key uniquely identifies a partitioned set of events in a given time window.

Index

• type AlignedKeyedWindow
  • func NewKeyedWindow(start time.Time, end time.Time) *AlignedKeyedWindow
  • func (kw *AlignedKeyedWindow) AddKey(key string)
  • func (kw *AlignedKeyedWindow) EndTime() time.Time
  • func (kw *AlignedKeyedWindow) Keys() []string
  • func (kw *AlignedKeyedWindow) Partitions() []partition.ID
  • func (kw *AlignedKeyedWindow) StartTime() time.Time

Types

type AlignedKeyedWindow

type AlignedKeyedWindow struct {
	// Start start time of the window
	Start time.Time
	// End end time of the window
	End time.Time
	// contains filtered or unexported fields
}

AlignedKeyedWindow maintains association between keys and a window. In a keyed stream, we need to close all the partitions when the watermark is past the window.

func NewKeyedWindow

func NewKeyedWindow(start time.Time, end time.Time) *AlignedKeyedWindow

NewKeyedWindow creates a new keyed window

func (*AlignedKeyedWindow) AddKey

func (kw *AlignedKeyedWindow) AddKey(key string)

AddKey adds a key to an existing window

func (*AlignedKeyedWindow) EndTime

func (kw *AlignedKeyedWindow) EndTime() time.Time

EndTime returns end of the window.

func (*AlignedKeyedWindow) Keys

func (kw *AlignedKeyedWindow) Keys() []string

func (*AlignedKeyedWindow) Partitions

func (kw *AlignedKeyedWindow) Partitions() []partition.ID

Partitions returns an array of partitions for a window

func (*AlignedKeyedWindow) StartTime

func (kw *AlignedKeyedWindow) StartTime() time.Time

StartTime returns start of the window.