io.cloudevents

Interface CloudEvent<T>

All Known Implementing Classes:

DefaultCloudEventImpl

public interface CloudEvent<T>

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

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.String>	getContentType() Describe the data encoding format
java.util.Optional<T>	getData() The event payload.
java.util.Optional<java.util.List<Extension>>	getExtensions()
java.lang.String	getId() ID of the event.
java.util.Optional<java.net.URI>	getSchemaURL() A link to the schema that the data attribute adheres to.
java.net.URI	getSource() This describes the event producer.
java.lang.String	getSpecVersion() The version of the CloudEvents specification which the event uses.
java.util.Optional<java.time.ZonedDateTime>	getTime() Timestamp of when the event happened.
java.lang.String	getType() Type of occurrence which has happened.

Method Detail

getType

java.lang.String getType()

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

getSpecVersion

java.lang.String getSpecVersion()

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

getSource

java.net.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.

getId

java.lang.String getId()

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

getTime

java.util.Optional<java.time.ZonedDateTime> getTime()

Timestamp of when the event happened.

getSchemaURL

java.util.Optional<java.net.URI> getSchemaURL()

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

getContentType

java.util.Optional<java.lang.String> getContentType()

Describe the data encoding format

getData

java.util.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).

getExtensions

java.util.Optional<java.util.List<Extension>> getExtensions()