Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

cloudevents

package module

Go to main page

Versions in this module

v1

v1.1.1

Sep 13, 2026

v1.1.0

Sep 9, 2026

Changes in this version

+ var ErrInvalidAdapterInput = errors.New("cloudevents golib adapter: invalid input")

+ var ErrMetadataCollision = errors.New("cloudevents golib adapter: metadata collision")

+ var ErrSchemaMapping = errors.New("cloudevents golib adapter: schema mapping")

+ var ErrSchemaViolation = errors.New("cloudevents golib adapter: schema violation")

+ var ErrUntrustedMetadata = errors.New("cloudevents golib adapter: metadata is untrusted")

+ type AdapterLoss struct

+ Field string

+ Reason string

+ type AdapterReport struct

+ Losses []AdapterLoss

v1.0.0

Aug 26, 2026

Changes in this version

+ const JSONBatchMediaType

+ const JSONMediaType

+ var ErrContextRequired = errors.New("cloudevents: context required")

+ var ErrConversionLoss = errors.New("cloudevents: conversion loss")

+ var ErrDataRequired = errors.New("cloudevents: event data required")

+ var ErrInvalidAttribute = errors.New("cloudevents: invalid attribute")

+ var ErrInvalidData = errors.New("cloudevents: invalid data")

+ var ErrInvalidEvent = errors.New("cloudevents: invalid event")

+ var ErrLimitExceeded = errors.New("cloudevents: limit exceeded")

+ var ErrSchemaRequired = errors.New("cloudevents: schema URI required")

+ var ErrSchemaValidatorRequired = errors.New("cloudevents: schema validator required")

+ var ErrUnsupportedMode = errors.New("cloudevents: unsupported content mode")

+ func EncodeHTTP(events []Event, mode ContentMode) (http.Header, []byte, error)

+ func EncodeJSON(event Event) ([]byte, error)

+ func EncodeJSONBatch(events []Event) ([]byte, error)

+ func EncodeKafkaWithReport(event Event, mode ContentMode, key []byte) (KafkaRecord, ConversionReport, error)

+ func KafkaPartitionKey(event Event) ([]byte, bool)

+ func ValidateSchema(ctx context.Context, event Event, validator SchemaValidator) error

+ type Attribute struct

+ func NewBinaryAttribute(value []byte) Attribute

+ func NewBooleanAttribute(value bool) Attribute

+ func NewIntegerAttribute(value int64) (Attribute, error)

+ func NewPartitionKeyAttribute(value string) (Attribute, error)

+ func NewStringAttribute(value string) (Attribute, error)

+ func NewTimestampAttribute(value time.Time) Attribute

+ func NewTraceParentAttribute(value string) (Attribute, error)

+ func NewTraceStateAttribute(value string) (Attribute, error)

+ func NewURIAttribute(value string) (Attribute, error)

+ func NewURIReferenceAttribute(value string) (Attribute, error)

+ func (a Attribute) Bytes() []byte

+ func (a Attribute) Kind() AttributeKind

+ func (a Attribute) String() string

+ type AttributeKind uint8

+ const AttributeBinary

+ const AttributeBoolean

+ const AttributeInteger

+ const AttributeString

+ const AttributeTimestamp

+ const AttributeURI

+ const AttributeURIReference

+ type Attributes struct

+ DataContentType string

+ DataSchema string

+ Extensions map[string]Attribute

+ ID string

+ Source string

+ Subject string

+ Time *time.Time

+ Type string

+ type ContentMode uint8

+ const BatchMode

+ const BinaryMode

+ const StructuredMode

+ type ConversionLoss struct

+ Field string

+ Reason string

+ type ConversionReport struct

+ Losses []ConversionLoss

+ func EncodeHTTPWithReport(events []Event, mode ContentMode) (http.Header, []byte, ConversionReport, error)

+ func EncodeJSONBatchWithReport(events []Event) ([]byte, ConversionReport, error)

+ func EncodeJSONWithReport(event Event) ([]byte, ConversionReport, error)

+ type Data struct

+ func NewBinaryData(value []byte) Data

+ func NewJSONData(value []byte) (Data, error)

+ func NewTextData(value string) (Data, error)

+ func (d Data) Bytes() []byte

+ func (d Data) Kind() DataKind

+ func (d Data) Present() bool

+ type DataKind uint8

+ const DataAbsent

+ const DataBinary

+ const DataJSON

+ const DataText

+ type Event struct

+ func DecodeJSON(value []byte, limits Limits) (Event, error)

+ func DecodeJSONBatch(value []byte, limits Limits) ([]Event, error)

+ func NewEvent(attributes Attributes, data Data) (Event, error)

+ func (e Event) Data() Data

+ func (e Event) DataContentType() (string, bool)

+ func (e Event) DataSchema() (string, bool)

+ func (e Event) Extension(name string) (Attribute, bool)

+ func (e Event) Extensions() map[string]Attribute

+ func (e Event) ID() string

+ func (e Event) Source() string

+ func (e Event) SpecVersion() string

+ func (e Event) Subject() (string, bool)

+ func (e Event) Time() (time.Time, bool)

+ func (e Event) Type() string

+ func (e Event) Validate() error

+ type HTTPMessage struct

+ Events []Event

+ Mode ContentMode

+ func DecodeHTTP(ctx context.Context, header http.Header, body io.Reader, limits Limits) (HTTPMessage, error)

+ type Issue struct

+ Code IssueCode

+ Field string

+ type IssueCode string

+ const IssueAbsoluteURIRequired

+ const IssueInvalidAttribute

+ const IssueInvalidMediaType

+ const IssueInvalidName

+ const IssueInvalidString

+ const IssueInvalidURIReference

+ const IssueRequired

+ const IssueReservedName

+ type KafkaHeader struct

+ Key string

+ Value []byte

+ type KafkaMessage struct

+ Event Event

+ Key []byte

+ Mode ContentMode

+ TransportHeaders []KafkaHeader

+ func DecodeKafka(record KafkaRecord, limits Limits) (KafkaMessage, error)

+ type KafkaRecord struct

+ Headers []KafkaHeader

+ Key []byte

+ Value []byte

+ func EncodeKafka(event Event, mode ContentMode, key []byte) (KafkaRecord, error)

+ type Limits struct

+ MaxAttributeNameBytes int

+ MaxAttributeValueBytes int

+ MaxAttributes int

+ MaxBatchEvents int

+ MaxDataBytes int64

+ MaxDepth int

+ MaxEventBytes int64

+ MaxKafkaHeaderNameBytes int

+ MaxKafkaHeaderValueBytes int

+ MaxKafkaHeaders int

+ MaxKafkaKeyBytes int

+ func DefaultLimits() Limits

+ type SchemaValidator interface

+ Validate func(ctx context.Context, uri string, contentType string, data []byte) error

+ type ValidationError struct

+ func (e *ValidationError) Error() string

+ func (e *ValidationError) Issues() []Issue

+ func (e *ValidationError) Unwrap() error