Package io.cloudevents

Class CloudEventBuilder<T>

java.lang.Object

io.cloudevents.CloudEventBuilder<T>

Type Parameters:

T - type of the data field

public class CloudEventBuilder<T>
extends java.lang.Object

Builder class to create a Java Object representing a CloudEvent implementation

Constructor Summary

Constructors

Constructor	Description
CloudEventBuilder()

Method Summary

Modifier and Type	Method	Description
CloudEvent<T>	build()	Constructs a new CloudEvent with the previously-set configuration.
CloudEventBuilder<T>	contentType(java.lang.String contentType)	Describe the data encoding format
CloudEventBuilder<T>	data(T data)	The event payload.
CloudEventBuilder<T>	eventID(java.lang.String eventID)	ID of the event.
CloudEventBuilder<T>	eventTime(java.time.ZonedDateTime eventTime)	Timestamp of when the event happened.
CloudEventBuilder<T>	eventType(java.lang.String eventType)	Type of occurrence which has happened.
CloudEventBuilder<T>	eventTypeVersion(java.lang.String eventTypeVersion)	The version of the eventType.
CloudEventBuilder<T>	extensions(java.util.Map extensions)	This is for additional metadata and this does not have a mandated structure.
CloudEventBuilder<T>	schemaURL(java.net.URI schemaURL)	A link to the schema that the data attribute adheres to.
CloudEventBuilder<T>	source(java.net.URI source)	This describes the event producer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CloudEventBuilder

public CloudEventBuilder()

Method Detail

eventType

public CloudEventBuilder<T> eventType(java.lang.String eventType)

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

eventTypeVersion

public CloudEventBuilder<T> eventTypeVersion(java.lang.String eventTypeVersion)

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

source

public CloudEventBuilder<T> source(java.net.URI source)

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.

eventID

public CloudEventBuilder<T> eventID(java.lang.String eventID)

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

eventTime

public CloudEventBuilder<T> eventTime(java.time.ZonedDateTime eventTime)

Timestamp of when the event happened.

schemaURL

public CloudEventBuilder<T> schemaURL(java.net.URI schemaURL)

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

contentType

public CloudEventBuilder<T> contentType(java.lang.String contentType)

Describe the data encoding format

extensions

public CloudEventBuilder<T> extensions(java.util.Map extensions)

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.

data

public CloudEventBuilder<T> data(T data)

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

build

public CloudEvent<T> build()

Constructs a new CloudEvent with the previously-set configuration.