/* Still to be checked: search for ??? */

syntax = "proto3";

message VES_Event {

    // -------------- VES CommonEventHeader adapted to GPB  ----------------
    // Source: https://git.opnfv.org/ves/tree/tests/docs/ves_data_model.json
    //         2017-05-13 Align with VES 5.0 schema as published by AT&T.
    //         blob: ca948ff67e8a2de4e2a47cffc4d4d2893170ab76
    // + note on how to fill for RTPM/PCMD/Calltrace ???

    message CommonEventHeader {
        float version = 1;                // required, "version of the event header" [value ???]
        enum Domain {
            FAULT = 0;
            HEARTBEAT = 1;
            MEASUREMENTS_FOR_VF_SCALING = 2;
            MOBILE_FLOW = 3;
            SIP_SIGNALING = 4;
            STATE_CHANGE = 5;
            SYSLOG = 6;
            THRESHOLD_CROSSING_ALERT = 7;
            VOICE_QUALITY = 8;
            OTHER = 9;

            RTPM = 10;
            PM = 11;
            CALLTRACE=12;
        }
        Domain domain = 2;                 // required, "the eventing domain associated with the event" [map to string]

        uint32 sequence = 3;               // required, "ordering of events communicated by an event source instance or 0 if not needed"

        enum Priority {
            NORMAL = 0;
            LOW = 1;
            MEDIUM = 2;
            HIGH = 3;
        }
        Priority priority = 4;             // required, "processing priority"

        string eventId = 5;                // required, "event key that is unique to the event source"
        string eventName = 6;              // required, "unique event name"
        string eventType = 7;              // "for example - applicationVnf, guestOS, hostOS, platform"

        uint64 lastEpochMicrosec = 8;      // required, for RTPM/PM: end of the measurement period, CALLTRACE: trigger time???, "the latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds"
        uint64 startEpochMicrosec = 9;     // required, for RTPM/PM: beginning of the measurement period, PCMD???: beginning of the measurement, CALLTRACE: message time???, "the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed since 1 Jan 1970 not including leap seconds"

        string nfNamingCode = 10;          // "4 character network function type, aligned with vnf naming standards"
        string nfcNamingCode = 11;         // "3 character network function component type, aligned with vfc naming standards"

        string reportingEntityId = 12;     // "UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the ATT enrichment process"
        string reportingEntityName = 13;   // required, "name of the entity reporting the event, for example, an EMS name; may be the same as sourceName"
        string sourceId = 14;              // "UUID identifying the entity experiencing the event issue; must be populated by the ATT enrichment process"
        string sourceName = 15;            // required, "name of the entity experiencing the event issue"

        reserved "InternalHeaderFields";   // "enrichment fields for internal VES Event Listener service use only, not supplied by event sources"
        reserved 100;
    }

    CommonEventHeader commonEventHeader=1;
    
    oneof eventFields {
        bytes pmFields=2;                   // if domain=RTPM/PM.
        bytes ctFields=3;                   // if domain=CALLTRACE.
    }
}

message VES_EventList {
    repeated VES_Event vesEvent=1;
}