Versions Compared

Old Version 104

changes.mady.by.user Toine Siebelink

Saved on

compared with

New Version 105

changes.mady.by.user Toine Siebelink

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Expand
titleNCMP Async Batch Response Event - Client Topic

BatchResponseEvent Object

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotesCloudEvents Mapping
eventIDstringThe unique id identifying the event generated by DMIx

standard ( id ) 
eventCorrelationIdstring

The request id passed by NCMP

x

extensions ( correlationid )
eventTimestringThe timestamp when original event occurredx

standard ( time ) 
eventTypestringThe type of the eventx

standard ( type) 
eventSchemastring

The event schema for async request response events

x

standard ( dataschema) 
eventSchemaVersionstring

The event schema version for async request response events

x

N/A included in 'dataschema'
eventEventThe payload of an event
xJava object not yet defined by schema, see issue #2standard ( data ) 


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

FieldTypeDescriptionKafka HeaderEvent Payload FieldNotes
No Properties defined (Entire event treated as single object)

...


CNCF Cloud Event alignment

Introduction

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 kafka headers or part of the actual payload ( fields other than "data" are sent as kafka 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 methodExample ValueNotes

eventId

id

.withId()
Mandatory

eventSource

source

.withSource()
Mandatory

N/A

specversion  (default 1.0)

.v1()1.0Mandatory  - This is the version of the cloud events

eventType

type

.withType()
Mandatory

eventTime

time

.withTime()
Optional

eventSchema

dataschema

.withDataSchema()

Optional  includes the version of the schema


datacontenttype
withDataContentType()
application/jsonOptional
eventCorrelationIdcorrelationid.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 applies to the event which has this field.

eventdata.withData(json TBC)
Mandatory actual event/payload now would be under "data" field.

...