Signed-off-by: GitHub <noreply@github.com> Co-authored-by: slinkydeveloper <slinkydeveloper@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| README.md | ||
| pom.xml | ||
README.md
CloudEvents API
For Maven based projects, use the following dependency:
<dependency>
<groupId>io.cloudevents</groupId>
<artifactId>cloudevents-api</artifactId>
<version>2.0.0.RC1</version>
</dependency>
Features
This package provides the base interfaces used by the SDK. In particular:
CloudEventis the main interface representing a read only CloudEvent in-memory representationExtensionrepresents a materialized in-memory representation of a CloudEvent extensionSpecVersionis an enum of CloudEvents' specification versions supported by this SDK version.CloudEventVisitor/CloudEventVisitableare the interfaces used by the SDK to implement protocol bindings/event formats. A 3rd party implementer can implement these interfaces directly in itsCloudEventin order to customize/implement efficiently the marshalling/unmarshalling process. These interfaces are optional and, if yourCloudEventdoesn't implement it, a default implementation is provided by the SDK.
cloudevents-core provides the implementation of these interfaces, and a 3rd party implementer can grab this package
to implement specialized CloudEvent in-memory representations.