dcae-analytics/dcae-analytics-model/src/main/java/org/onap/dcae/analytics/model/cef/CommonEventHeader.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.analytics.model.cef;
  21
  22 import lombok.Data;
  23 import lombok.EqualsAndHashCode;
  24
  25 /**
  26  * Fields common to all Events
  27  *
  28  * @author Rajiv Singla
  29  */
  30 @Data
  31 @EqualsAndHashCode(callSuper = true)
  32 public class CommonEventHeader extends BaseCEFModel {
  33
  34
  35     private static final long serialVersionUID = 1L;
  36
  37     /**
  38      * The eventing domain associated with this event
  39      */
  40     private Domain domain;
  41
  42     /**
  43      * Event key that is unique to the event source
  44      */
  45     private String eventId;
  46
  47     /**
  48      * Unique event name
  49      */
  50     private String eventName;
  51
  52
  53     /**
  54      * Event type e.g. applicationVnf, guestOS, hostOS, platform
  55      */
  56     private String eventType;
  57
  58
  59     /**
  60      * Enrichment fields for internal VES Event Listener service use only, not supplied by event sources
  61      */
  62     private InternalHeaderFields internalHeaderFields;
  63
  64
  65     /**
  66      * The latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since
  67      * 1 Jan 1970 not including leap seconds
  68      */
  69     private Long lastEpochMicrosec;
  70
  71
  72     /**
  73      * Three character network function component type as aligned with vfc naming standards
  74      */
  75     private String nfcNamingCode;
  76
  77
  78     /**
  79      * Four character network function type as aligned with vnf naming standards
  80      */
  81     private String nfNamingCode;
  82
  83
  84     /**
  85      * Processing Priority
  86      */
  87     private Priority priority;
  88
  89
  90     /**
  91      * UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the
  92      * enrichment process
  93      */
  94     private String reportingEntityId;
  95
  96
  97     /**
  98      * Name of the entity reporting the event, for example, an EMS name; may be the same as sourceName
  99      */
 100     private String reportingEntityName;
 101
 102
 103     /**
 104      * Ordering of events communicated by an event source instance or 0 if not needed
 105      */
 106     private Integer sequence;
 107
 108
 109     /**
 110      * UUID identifying the entity experiencing the event issue; must be populated by the enrichment process
 111      */
 112     private String sourceId;
 113
 114
 115     /**
 116      * Name of the entity experiencing the event issue
 117      */
 118     private String sourceName;
 119
 120
 121     /**
 122      * the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed
 123      * since 1 Jan 1970 not including leap seconds
 124      */
 125     private Long startEpochMicrosec;
 126
 127
 128     /**
 129      * Version of the event header
 130      */
 131     private Float version;
 132 }