Versions Compared

Key

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

...

Expand
titleDMI Async Batch Response Event


Excerpt

BatchResponseEvent Object

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

Mandatory

Generated by DMI-Plugin
eventCorrelationIdstring

The request id passed by NCMP

x
Mandatory. This is requestId that NCMP sent to client as an ACK.
Example : “request-1234" (UUID)
extensions (correlationid)
eventTargetstringThe destination topic of the clientx
Mandatory. TBC example: my-topicextensions ( target  TBC)
sourcestringThe source of the event

Optional. Example : dmi-plugin:enm-1 (dmi service name)
eventTimestringThe timestamp when original event occurredx

Optional. The timestamp should follow that on https://www.rfc-editor.org/rfc/rfc3339#section-5. This follows ISO 8601 and is what is used/referenced in 3GPP standards
Example: 1985-04-12T23:20:50.52Z this represents 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC.

standard ( time) 
eventTypestringThe type of the eventx
Mandatory. NCMP owns eventType that would be used by dmi-plugins
The Convention of eventType and Schema names is under discussion, see open issue
#17on 
#17 on  CPS-1515 Spikestandard ( type ) 
eventSchemastring

The event schema for async request response events

x
Mandatory.
The Convention of eventType and Schema names is under discussion, see open issue
#17on 
#17 on  CPS-1515 Spike
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 ) 
N/A
specversionString
N/A
Version of CNCF specx
hardcoded value of 1.0standard (hardcode value)

specversion



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

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


...