io.cloudevents

Interface CloudEvent<T>

All Known Implementing Classes:

DefaultCloudEventImpl

public interface CloudEvent<T>

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

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLOUD_EVENTS_VERSION_KEY
static java.lang.String	EVENT_ID_KEY
static java.lang.String	EVENT_TIME_KEY
static java.lang.String	EVENT_TYPE_KEY
static java.lang.String	EVENT_TYPE_VERSION_KEY
static java.lang.String	HEADER_PREFIX
static java.lang.String	SCHEMA_URL_KEY
static java.lang.String	SOURCE_KEY

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCloudEventsVersion() The version of the CloudEvents specification which the event uses.
java.util.Optional<java.lang.String>	getContentType() Describe the data encoding format
java.util.Optional<T>	getData() The event payload.
java.lang.String	getEventID() ID of the event.
java.util.Optional<java.time.ZonedDateTime>	getEventTime() Timestamp of when the event happened.
java.lang.String	getEventType() Type of occurrence which has happened.
java.util.Optional<java.lang.String>	getEventTypeVersion() The version of the eventType.
java.util.Optional<java.util.Map>	getExtensions() This is for additional metadata and this does not have a mandated structure.
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.

Field Detail

EVENT_TYPE_KEY

static final java.lang.String EVENT_TYPE_KEY

See Also:

Constant Field Values

CLOUD_EVENTS_VERSION_KEY

static final java.lang.String CLOUD_EVENTS_VERSION_KEY

See Also:

Constant Field Values

SOURCE_KEY

static final java.lang.String SOURCE_KEY

See Also:

Constant Field Values

EVENT_ID_KEY

static final java.lang.String EVENT_ID_KEY

See Also:

Constant Field Values

EVENT_TYPE_VERSION_KEY

static final java.lang.String EVENT_TYPE_VERSION_KEY

See Also:

Constant Field Values

EVENT_TIME_KEY

static final java.lang.String EVENT_TIME_KEY

See Also:

Constant Field Values

SCHEMA_URL_KEY

static final java.lang.String SCHEMA_URL_KEY

See Also:

Constant Field Values

HEADER_PREFIX

static final java.lang.String HEADER_PREFIX

See Also:

Constant Field Values

Method Detail

getEventType

java.lang.String getEventType()

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

getCloudEventsVersion

java.lang.String getCloudEventsVersion()

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.

getEventID

java.lang.String getEventID()

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

getEventTypeVersion

java.util.Optional<java.lang.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

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

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

getExtensions

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

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