event

Documentation

Index

• Variables
• type ErrQueryFieldHasZeroValue
  • func (err ErrQueryFieldHasZeroValue) Error() string
• type ErrQueryFieldIsAlreadySet
  • func (err ErrQueryFieldIsAlreadySet) Error() string
• type Name
  • func (e Name) Validate() error
• type Query
• type QueryField

Variables

var AllowedEventFormat = regexp.MustCompile(`^[a-zA-Z]+$`)

AllowedEventFormat defines the allowed format for an event

var StateEventName = Name("TestState")

StateEventName is the name of the event used to emit state information

Types

type ErrQueryFieldHasZeroValue

type ErrQueryFieldHasZeroValue struct {
	QueryField QueryField
}

ErrQueryFieldHasZeroValue is returned when a QueryFields failed validation due to a QueryField with a zero value (this is unexpected and forbidden).

func (ErrQueryFieldHasZeroValue) Error

func (err ErrQueryFieldHasZeroValue) Error() string

type ErrQueryFieldIsAlreadySet

type ErrQueryFieldIsAlreadySet struct {
	FieldValue interface{}
	QueryField QueryField
}

ErrQueryFieldIsAlreadySet is returned when QueryFields failed validation due to multiple QueryField which modifies the same field (this is unexpected and forbidden).

func (ErrQueryFieldIsAlreadySet) Error

func (err ErrQueryFieldIsAlreadySet) Error() string

type Name

type Name string

Name is a custom type which represents the name of an event

func (Name) Validate

func (e Name) Validate() error

Validate validates that the event name conforms with the framework API

type Query

type Query struct {
	JobID            types.JobID
	EventNames       []Name
	EmittedStartTime time.Time
	EmittedEndTime   time.Time
}

Query wraps information that are used to build event queries for all type of event objects

type QueryField

type QueryField interface{}