Page Comparison

Table of Contents

...

Expand

title	NCMP Async Batch Response Event - Client Topic

BatchResponseEvent Object

Field	Type	Description	Header	Payload	Notes	CloudEvents Mapping
eventID	string	The unique id identifying the event generated by DMI	X			standard (`id`)
eventCorrelationId	string	The request id passed by NCMP	X			extensions (`correlationid`)
eventTime	string	The timestamp when original event occurred	X			standard (`time`)
eventType	string	The type of the event	X			standard (`type`)
source	string	The source of the event	X		NEW see decision #18, value 'ncmp' TBC	standard (`source`)
eventSchema	string	The event schema for async request response events	X			standard (`dataschema`)
~~eventSchemaVersion~~	~~string~~	~~The event schema version for async request response events~~	X			~~N/A included in '`dataschema`'~~
event	Event	The payload of an event		X	Java object not yet defined by schema, see issue #2	standard (`data`)

Type: Event (cps:org.onap.cps.ncmp.event.async:ncmp-async-batch-response-event-schema:v1)

Field	Type	Description	Header	Payload	Notes
No Properties defined (Entire event treated as single object)

CNCF Cloud Event alignment

CNCF CloudEvents is a specification for describing event data in common formats to provide interoperability across services, platforms and systems.

These cloud events will be applied to all the internal and external events we have in CPS , NCMP and DMI Plugin.
Cloud events will be taking care of the fields which are part of Headers or part of the actual payload (fields other than "data" are sent as Headers)
These CNCF cloud events will be applied to all the events listed in above sections (LCM , DMI Data AVC etc.)

...

Before	After¹	CloudeEvent builder method	Example Value	Notes
eventId	(ce_)id	.withId()		Mandatory
eventSource	(ce_)source	.withSource()		Mandatory
N/A	(ce_)specversion (default 1.0)	.v1()	1.0	Mandatory - This is the version of the cloud events
eventType	(ce_)type	.withType()		Mandatory
eventTime	(ce_)time	.withTime()		Optional (could be Mandatory for
eventSchema	(ce_)dataschema	.withDataSchema()		Optional includes the version of the schema
	content-type²	withDataContentType()	application/json	Optional
eventCorrelationId	(ce_)correlationid	.withExtension()		Optional This will be part of the extensions field in the cloud events and all the restrictions of the attribute field naming applies to it. i.e these fields will be in the small case. This is marked as optional as it only applies to some events.
event	(ce_)data	.withData(json TBC)		Mandatory actual event/payload now would be under "data" field.

...