...
| Expand |
|---|
| title | DMI Async Batch Response Event |
|---|
|
BatchResponseEvent Object | Field | Type | Description | Kafka Header | Event Payload Field | Notes | CloudEvents Mapping |
|---|
| eventID | string | The unique id identifying the event generated by DMI | x |
standard ( id ) |
| Mandatory | Generated by DMI-Plugin | | eventCorrelationId | string | 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) | | eventTarget | string | The destination topic of the client | x |
extensions ( target
| Mandatory. TBC example: my-topic | extensions ( target TBC) | | source | string | The source of the event |
|
| Optional. Example : dmi-plugin:enm-1 (dmi service name) |
| | eventTime | string |
The timestamp when original event occurred | x | | The timestamp when original event occurred | x |
| 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) | | eventType | string | The type of the event | x |
| 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 CPS-1515 Spike | standard ( type ) | | eventSchema | string | The event schema for async request response events | x |
| Mandatory.
The Convention of eventType and Schema names is under discussion, see open issue #17on CPS-1515 Spike
| 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 ) | | N/A | N/A | Version of CNCF |
|
|
| standard (hardcode value)
specversion |
Type: Event (cps:org.onap.cps.ncmp.event.async:dmi-async-batch-response-event-schema:v1) | Field | Type | Description | Kafka Header | Event Payload Field | Notes |
|---|
| No Properties defined (Entire event treated as single object) |
|
...
CNCF Cloud Event alignment
Introduction
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 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 method | Example Value | Notes |
|---|
eventId | id | .withId() |
| Mandatory |
eventSource | source | .withSource() |
| Mandatory |
N/A | specversion (default 1.0) | .v1() | 1.0 | Mandatory - 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/json | Optional |
| eventCorrelationId | 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 | data | .withData(json TBC) |
| Mandatory actual event/payload now would be under "data" field. |
...