envelope

Documentation

Index

• Constants
• type Annotations
• type Contexts
  • func BuildContextsFromRequest(c *gin.Context) Contexts
  • func (c Contexts) Scan(input interface{}) error
  • func (c Contexts) Value() (driver.Value, error)
• type Envelope
  • func NewEnvelope(conf config.App) Envelope
  • func (e *Envelope) AsByte() ([]byte, error)
  • func (e *Envelope) AsMap() (map[string]interface{}, error)
• type Event
• type JsonbEnvelope
• type Payload
  • func (p *Payload) AsByte() ([]byte, error)
  • func (p Payload) Scan(input interface{}) error
  • func (p Payload) Value() (driver.Value, error)
• type PayloadValidationError
• type SelfDescribingContext
• type SelfDescribingEvent
• type SelfDescribingPayload
  • func (e SelfDescribingPayload) AsByte() ([]byte, error)
  • func (e SelfDescribingPayload) AsMap() (map[string]interface{}, error)
  • func (e SelfDescribingPayload) PayloadAsByte() ([]byte, error)
  • func (e SelfDescribingPayload) Scan(input interface{}) error
  • func (e SelfDescribingPayload) SchemaName() *string
  • func (e SelfDescribingPayload) Value() (driver.Value, error)
• type StringEnvelope
• type Validation
  • func (e Validation) Scan(input interface{}) error
  • func (e Validation) Value() (driver.Value, error)
• type ValidationError
  • func (e *ValidationError) Scan(input interface{}) error
  • func (e *ValidationError) Value() (driver.Value, error)

Constants

const (
	PROTOCOL  string = "protocol"
	VENDOR    string = "vendor"
	NAMESPACE string = "namespace"
	VERSION   string = "version"
	SCHEMA    string = "schema"
	IS_VALID  string = "isValid"
)

const HTTP_HEADERS_CONTEXT string = "io.silverton/buz/internal/contexts/httpHeaders/v1.0.json"

Types

type Annotations

type Annotations struct{}

Reserving this for future use.

type Contexts

type Contexts map[string]interface{}

func BuildContextsFromRequest

func BuildContextsFromRequest(c *gin.Context) Contexts

func (Contexts) Scan

func (c Contexts) Scan(input interface{}) error

func (Contexts) Value

func (c Contexts) Value() (driver.Value, error)

type Envelope

type Envelope struct {
	Uuid            uuid.UUID        `json:"uuid"`
	Timestamp       time.Time        `json:"timestamp" sql:"index"`
	BuzTimestamp    time.Time        `json:"buzTimestamp" sql:"index"`
	BuzVersion      string           `json:"buzVersion"`
	BuzName         string           `json:"buzName"`
	BuzEnv          string           `json:"buzEnv"`
	Protocol        string           `json:"protocol"`
	Schema          string           `json:"schema"`
	Vendor          string           `json:"vendor"`
	Namespace       string           `json:"namespace"`
	Version         string           `json:"version"`
	IsValid         bool             `json:"isValid"`
	ValidationError *ValidationError `json:"validationError,omitempty" gorm:"type:json"`
	Contexts        *Contexts        `json:"contexts,omitempty" gorm:"type:json"`
	Payload         Payload          `json:"payload" gorm:"type:json"`
}

An envelope consisting of minimally-defined properties

func NewEnvelope

func NewEnvelope(conf config.App) Envelope

Build a new envelope with base fields populated

func (*Envelope) AsByte

func (e *Envelope) AsByte() ([]byte, error)

func (*Envelope) AsMap

func (e *Envelope) AsMap() (map[string]interface{}, error)

type Event

type Event interface {
	SchemaName() *string
	PayloadAsByte() ([]byte, error)
	Value() (driver.Value, error)
	Scan(input interface{}) error
}

type JsonbEnvelope

type JsonbEnvelope struct {
	Uuid            uuid.UUID        `json:"uuid" gorm:"type:uuid"`
	Timestamp       time.Time        `json:"timestamp" sql:"index"`
	BuzTimestamp    time.Time        `json:"buzTimestamp" sql:"index"`
	BuzVersion      string           `json:"buzVersion"`
	BuzName         string           `json:"buzName"`
	BuzEnv          string           `json:"buzEnv"`
	Protocol        string           `json:"protocol"`
	Schema          string           `json:"schema"`
	Vendor          string           `json:"vendor"`
	Namespace       string           `json:"namespace"`
	Version         string           `json:"version"`
	IsValid         bool             `json:"isValid"`
	ValidationError *ValidationError `json:"validationError,omitempty" gorm:"type:jsonb"`
	Contexts        *Contexts        `json:"contexts,omitempty" gorm:"type:jsonb"`
	Payload         Payload          `json:"payload" gorm:"type:jsonb"`
}

type Payload

type Payload map[string]interface{}

func (*Payload) AsByte

func (p *Payload) AsByte() ([]byte, error)

func (Payload) Scan

func (p Payload) Scan(input interface{}) error

func (Payload) Value

func (p Payload) Value() (driver.Value, error)

type PayloadValidationError

type PayloadValidationError struct {
	Field       string `json:"field,omitempty"`
	Description string `json:"description,omitempty"`
	ErrorType   string `json:"errorType,omitempty"`
}

type SelfDescribingContext

type SelfDescribingContext SelfDescribingPayload

type SelfDescribingEvent

type SelfDescribingEvent struct {
	Contexts `json:"contexts"`
	Payload  SelfDescribingPayload `json:"payload"`
}

type SelfDescribingPayload

type SelfDescribingPayload struct {
	Schema string                 `json:"schema"`
	Data   map[string]interface{} `json:"data"`
}

func (SelfDescribingPayload) AsByte

func (e SelfDescribingPayload) AsByte() ([]byte, error)

func (SelfDescribingPayload) AsMap

func (e SelfDescribingPayload) AsMap() (map[string]interface{}, error)

func (SelfDescribingPayload) PayloadAsByte

func (e SelfDescribingPayload) PayloadAsByte() ([]byte, error)

func (SelfDescribingPayload) Scan

func (e SelfDescribingPayload) Scan(input interface{}) error

func (SelfDescribingPayload) SchemaName

func (e SelfDescribingPayload) SchemaName() *string

func (SelfDescribingPayload) Value

func (e SelfDescribingPayload) Value() (driver.Value, error)

type StringEnvelope

type StringEnvelope struct {
	Uuid            uuid.UUID        `json:"uuid" gorm:"type:uuid"`
	Timestamp       time.Time        `json:"timestamp" sql:"index"`
	BuzTimestamp    time.Time        `json:"buzTimestamp" sql:"index"`
	BuzVersion      string           `json:"buzVersion"`
	BuzName         string           `json:"buzName"`
	BuzEnv          string           `json:"buzEnv"`
	Protocol        string           `json:"protocol"`
	Schema          string           `json:"schema"`
	Vendor          string           `json:"vendor"`
	Namespace       string           `json:"namespace"`
	Version         string           `json:"version"`
	IsValid         bool             `json:"isValid"`
	ValidationError *ValidationError `json:"validationError,omitempty" gorm:"type:string"`
	Contexts        *Contexts        `json:"contexts,omitempty" gorm:"type:string"`
	Payload         Payload          `json:"payload" gorm:"type:string"`
}

type Validation

type Validation struct {
	IsValid *bool            `json:"isValid"`
	Error   *ValidationError `json:"error,omitempty"`
}

func (Validation) Scan

func (e Validation) Scan(input interface{}) error

func (Validation) Value

func (e Validation) Value() (driver.Value, error)

type ValidationError

type ValidationError struct {
	ErrorType       *string                  `json:"errorType,omitempty"`
	ErrorResolution *string                  `json:"errorResolution,omitempty"`
	Errors          []PayloadValidationError `json:"payloadValidationErrors,omitempty"`
}

func (*ValidationError) Scan

func (e *ValidationError) Scan(input interface{}) error

func (*ValidationError) Value

func (e *ValidationError) Value() (driver.Value, error)