dcae-analytics-model/src/main/java/org/openecomp/dcae/apod/analytics/model/domain/cef/CommonEventHeader.java

   1 /*
   2  * ===============================LICENSE_START======================================
   3  *  dcae-analytics
   4  * ================================================================================
   5  *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *   You may obtain a copy of the License at
  10  *
  11  *          http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  18  *  ============================LICENSE_END===========================================
  19  */
  20
  21 package org.openecomp.dcae.apod.analytics.model.domain.cef;
  22
  23 import lombok.Data;
  24 import lombok.EqualsAndHashCode;
  25
  26 /**
  27  * Fields common to all Events
  28  * <p>
  29  * @author Rajiv Singla . Creation Date: 10/17/2016.
  30  */
  31 @Data
  32 @EqualsAndHashCode(callSuper = true)
  33 public class CommonEventHeader extends BaseCEFModel {
  34
  35
  36     private static final long serialVersionUID = 1L;
  37
  38     /**
  39      * The eventing domain associated with this event
  40      *
  41      * @param domain New value for domain
  42      * @return The eventing domain associated with this event
  43      */
  44     private String domain;
  45
  46     /**
  47      * Event key that is unique to the event source
  48      *
  49      * @param eventId New value for event key
  50      * @return Event key that is unique to the event source
  51      */
  52     private String eventId;
  53
  54     /**
  55      * Function of the source e.g. eNodeB, MME, PCRF
  56      *
  57      * @param functionalRole New value for functional Role
  58      * @return Function of the source e.g. eNodeB, MME, PCRF
  59      */
  60     private String functionalRole;
  61
  62
  63     /**
  64      * The latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since
  65      * 1 Jan 1970 not including leap seconds
  66      *
  67      * @param lastEpochMicrosec New value for last Epoc Microsec
  68      * @return The latest unix time associated with the event from any component
  69      */
  70     private Long lastEpochMicrosec;
  71
  72
  73     /**
  74      * Processing Priority
  75      *
  76      * @param priority New value for processing Priority
  77      * @return Processing Priority
  78      */
  79     private Priority priority;
  80
  81
  82     /**
  83      * Name of the entity reporting the event, for example, an OAM VM
  84      *
  85      * @param reportingEntityName New value for reporting Entity Name
  86      * @return Name of the entity reporting the event, for example, an OAM VM
  87      */
  88     private String reportingEntityName;
  89
  90
  91     /**
  92      * Ordering of events communicated by an event source instance or 0 if not needed
  93      *
  94      * @param sequence New value for Sequence
  95      * @return Ordering of events communicated by an event source instance or 0 if not needed
  96      */
  97     private Integer sequence;
  98
  99
 100     /**
 101      * Name of the entity experiencing the event issue
 102      *
 103      * @param sourceName New value for source name
 104      * @return Name of the entity experiencing the event issue
 105      */
 106     private String sourceName;
 107
 108
 109     /**
 110      * the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed
 111      * since 1 Jan 1970 not including leap seconds
 112      *
 113      * @param startEpochMicrosec New value for start Epoc Microsec
 114      * @return The earliest unix time associated with the event from any component
 115      */
 116     private Long startEpochMicrosec;
 117 }