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 and Description
CloudEventBuilder()

Method Summary

Modifier and Type	Method and 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>	extension(Extension extension)
CloudEventBuilder<T>	id(java.lang.String id) ID of the event.
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.
CloudEventBuilder<T>	specVersion(java.lang.String specVersion) The version of the CloudEvents specification which the event uses.
CloudEventBuilder<T>	time(java.time.ZonedDateTime time) Timestamp of when the event happened.
CloudEventBuilder<T>	type(java.lang.String type) Type of occurrence which has happened.

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

specVersion

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

The version of the CloudEvents specification which the event uses.

type

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

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

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.

id

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

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

time

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

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

data

public CloudEventBuilder<T> data(T data)

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

extension

public CloudEventBuilder<T> extension(Extension extension)

build

public CloudEvent<T> build()

Constructs a new CloudEvent with the previously-set configuration.