io.streamzi.cloudevents

Interface CloudEvent<T>

All Known Implementing Classes:

CloudEventImpl

public interface CloudEvent<T>

An abstract event envelope, representing the 0.1 version of the CNCF CloudEvent spec.

Method Summary

Modifier and Type	Method and Description
String	getCloudEventsVersion() The version of the CloudEvents specification which the event uses.
Optional<String>	getContentType() Describe the data encoding format
Optional<T>	getData() The event payload.
String	getEventID() ID of the event.
Optional<ZonedDateTime>	getEventTime() Timestamp of when the event happened.
String	getEventType() Type of occurrence which has happened.
Optional<String>	getEventTypeVersion() The version of the eventType.
Optional<Map>	getExtensions() This is for additional metadata and this does not have a mandated structure.
Optional<URI>	getSchemaURL() A link to the schema that the data attribute adheres to.
URI	getSource() This describes the event producer.

Method Detail

getEventType

String getEventType()

Type of occurrence which has happened. Often this property is used for routing, observability, policy enforcement, etc.

getCloudEventsVersion

String getCloudEventsVersion()

The version of the CloudEvents specification which the event uses. This enables the interpretation of the context.

getSource

URI getSource()

This describes the event producer. Often this will include information such as the type of the event source, the organization publishing the event, and some unique identifiers. The exact syntax and semantics behind the data encoded in the URI is event producer defined.

getEventID

String getEventID()

ID of the event. The semantics of this string are explicitly undefined to ease the implementation of producers. Enables deduplication.

getEventTypeVersion

Optional<String> getEventTypeVersion()

The version of the eventType. This enables the interpretation of data by eventual consumers, requires the consumer to be knowledgeable about the producer.

getEventTime

Optional<ZonedDateTime> getEventTime()

Timestamp of when the event happened.

getSchemaURL

Optional<URI> getSchemaURL()

A link to the schema that the data attribute adheres to.

getContentType

Optional<String> getContentType()

Describe the data encoding format

getExtensions

Optional<Map> getExtensions()

This is for additional metadata and this does not have a mandated structure. This enables a place for custom fields a producer or middleware might want to include and provides a place to test metadata before adding them to the CloudEvents specification.

getData

Optional<T> getData()

The event payload. The payload depends on the eventType, schemaURL and eventTypeVersion, the payload is encoded into a media format which is specified by the contentType attribute (e.g. application/json).