TCA: Support for VES/A&AI enrichment
[dcaegen2/analytics/tca.git] / dcae-analytics-model / src / main / java / org / openecomp / dcae / apod / analytics / model / domain / cef / CommonEventHeader.java
index b3d625f..23556af 100644 (file)
-/*
- * ============LICENSE_START=========================================================
- * dcae-analytics
- * ================================================================================
- *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.
- * ================================================================================
- *  Licensed under the Apache License, Version 2.0 (the "License");
- *  you may not use this file except in compliance with the License.
- *  You may obtain a copy of the License at
- *
- *        http://www.apache.org/licenses/LICENSE-2.0
- *
- *  Unless required by applicable law or agreed to in writing, software
- *  distributed under the License is distributed on an "AS IS" BASIS,
- *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- *  See the License for the specific language governing permissions and
- *  limitations under the License.
- * ============LICENSE_END=========================================================
- */
-
-package org.openecomp.dcae.apod.analytics.model.domain.cef;
-
-import lombok.Data;
-import lombok.EqualsAndHashCode;
-
-/**
- * Fields common to all Events
- * <p>
- * @author Rajiv Singla. Creation Date: 08/15/2017.
- */
-@Data
-@EqualsAndHashCode(callSuper = true)
-public class CommonEventHeader extends BaseCEFModel {
-
-
-    private static final long serialVersionUID = 1L;
-
-    /**
-     * The eventing domain associated with this event
-     *
-     * @param domain New value for domain
-     * @return The eventing domain associated with this event
-     */
-    private Domain domain;
-
-    /**
-     * Event key that is unique to the event source
-     *
-     * @param eventId New value for event key
-     * @return Event key that is unique to the event source
-     */
-    private String eventId;
-
-    /**
-     * Unique event name
-     *
-     * @param eventName New value for event name
-     * @return Unique event name
-     */
-    private String eventName;
-
-
-    /**
-     * Event type e.g. applicationVnf, guestOS, hostOS, platform
-     *
-     * @param eventType New value for event type
-     * @return Event type e.g. applicationVnf, guestOS, hostOS, platform
-     */
-    private String eventType;
-
-
-    /**
-     * Enrichment fields for internal VES Event Listener service use only, not supplied by event sources
-     *
-     * @param internalHeaderFields new value for internal Header Fields
-     * @return Enrichment fields for internal VES Event Listener service use only, not supplied by event sources
-     */
-    private InternalHeaderFields internalHeaderFields;
-
-
-    /**
-     * 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
-     *
-     * @param lastEpochMicrosec New value for last Epoc Microsec
-     * @return The latest unix time associated with the event from any component
-     */
-    private Long lastEpochMicrosec;
-
-
-    /**
-     * Three character network function component type as aligned with vfc naming standards
-     *
-     * @param nfcNamingCode New value for nfc naming code
-     * @return Three character network function component type as aligned with vfc naming standards
-     */
-    private String nfcNamingCode;
-
-
-    /**
-     * Four character network function type as aligned with vnf naming standards
-     *
-     * @param nfNamingCode New value for nf naming code
-     * @return Four character network function type as aligned with vnf naming standards
-     */
-    private String nfNamingCode;
-
-
-    /**
-     * Processing Priority
-     *
-     * @param priority New value for processing Priority
-     * @return Processing Priority
-     */
-    private Priority priority;
-
-
-    /**
-     * UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the
-     * enrichment process
-     *
-     * @param reportingEntityId New value for reporting entity Id. Must be populated by the enrichment process
-     * @return UUID identifying the entity reporting the event populated by the enrichment process
-     */
-    private String reportingEntityId;
-
-
-    /**
-     * Name of the entity reporting the event, for example, an EMS name; may be the same as sourceName
-     *
-     * @param reportingEntityName New value for reporting Entity Name
-     * @return Name of the entity reporting the event, may be the same as sourceName
-     */
-    private String reportingEntityName;
-
-
-    /**
-     * Ordering of events communicated by an event source instance or 0 if not needed
-     *
-     * @param sequence New value for Sequence
-     * @return Ordering of events communicated by an event source instance or 0 if not needed
-     */
-    private Integer sequence;
-
-
-    /**
-     * UUID identifying the entity experiencing the event issue; must be populated by the enrichment process
-     *
-     * @param sourceId New value for source id. Must be populated by the enrichment process
-     * @return UUID identifying the entity experiencing the event issue
-     */
-    private String sourceId;
-
-
-    /**
-     * Name of the entity experiencing the event issue
-     *
-     * @param sourceName New value for source name
-     * @return Name of the entity experiencing the event issue
-     */
-    private String sourceName;
-
-
-    /**
-     * 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
-     *
-     * @param startEpochMicrosec New value for start Epoc Microsec
-     * @return The earliest unix time associated with the event from any component
-     */
-    private Long startEpochMicrosec;
-
-
-    /**
-     * Version of the event header
-     *
-     * @param version New value for version of the event header
-     * @return Version of the event header
-     */
-    private Float version;
-}
+/*\r
+ * ===============================LICENSE_START======================================\r
+ *  dcae-analytics\r
+ * ================================================================================\r
+ *    Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
+ * ================================================================================\r
+ *  Licensed under the Apache License, Version 2.0 (the "License");\r
+ *  you may not use this file except in compliance with the License.\r
+ *   You may obtain a copy of the License at\r
+ *\r
+ *          http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ *  Unless required by applicable law or agreed to in writing, software\r
+ *  distributed under the License is distributed on an "AS IS" BASIS,\r
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ *  See the License for the specific language governing permissions and\r
+ *  limitations under the License.\r
+ *  ============================LICENSE_END===========================================\r
+ */\r
+\r
+package org.openecomp.dcae.apod.analytics.model.domain.cef;\r
+\r
+import lombok.Data;\r
+import lombok.EqualsAndHashCode;\r
+\r
+/**\r
+ * Fields common to all Events\r
+ * <p>\r
+ * @author Rajiv Singla. Creation Date: 08/15/2017.\r
+ */\r
+@Data\r
+@EqualsAndHashCode(callSuper = true)\r
+public class CommonEventHeader extends BaseCEFModel {\r
+\r
+\r
+    private static final long serialVersionUID = 1L;\r
+\r
+    /**\r
+     * The eventing domain associated with this event\r
+     *\r
+     * @param domain New value for domain\r
+     * @return The eventing domain associated with this event\r
+     */\r
+    private Domain domain;\r
+\r
+    /**\r
+     * Event key that is unique to the event source\r
+     *\r
+     * @param eventId New value for event key\r
+     * @return Event key that is unique to the event source\r
+     */\r
+    private String eventId;\r
+\r
+    /**\r
+     * Unique event name\r
+     *\r
+     * @param eventName New value for event name\r
+     * @return Unique event name\r
+     */\r
+    private String eventName;\r
+\r
+\r
+    /**\r
+     * Event type e.g. applicationVnf, guestOS, hostOS, platform\r
+     *\r
+     * @param eventType New value for event type\r
+     * @return Event type e.g. applicationVnf, guestOS, hostOS, platform\r
+     */\r
+    private String eventType;\r
+\r
+\r
+    /**\r
+     * Enrichment fields for internal VES Event Listener service use only, not supplied by event sources\r
+     *\r
+     * @param internalHeaderFields new value for internal Header Fields\r
+     * @return Enrichment fields for internal VES Event Listener service use only, not supplied by event sources\r
+     */\r
+    private InternalHeaderFields internalHeaderFields;\r
+\r
+\r
+    /**\r
+     * The latest unix time aka epoch time associated with the event from any component--as microseconds elapsed since\r
+     * 1 Jan 1970 not including leap seconds\r
+     *\r
+     * @param lastEpochMicrosec New value for last Epoc Microsec\r
+     * @return The latest unix time associated with the event from any component\r
+     */\r
+    private Long lastEpochMicrosec;\r
+\r
+\r
+    /**\r
+     * Three character network function component type as aligned with vfc naming standards\r
+     *\r
+     * @param nfcNamingCode New value for nfc naming code\r
+     * @return Three character network function component type as aligned with vfc naming standards\r
+     */\r
+    private String nfcNamingCode;\r
+\r
+\r
+    /**\r
+     * Four character network function type as aligned with vnf naming standards\r
+     *\r
+     * @param nfNamingCode New value for nf naming code\r
+     * @return Four character network function type as aligned with vnf naming standards\r
+     */\r
+    private String nfNamingCode;\r
+\r
+\r
+    /**\r
+     * Processing Priority\r
+     *\r
+     * @param priority New value for processing Priority\r
+     * @return Processing Priority\r
+     */\r
+    private Priority priority;\r
+\r
+\r
+    /**\r
+     * UUID identifying the entity reporting the event, for example an OAM VM; must be populated by the\r
+     * enrichment process\r
+     *\r
+     * @param reportingEntityId New value for reporting entity Id. Must be populated by the enrichment process\r
+     * @return UUID identifying the entity reporting the event populated by the enrichment process\r
+     */\r
+    private String reportingEntityId;\r
+\r
+\r
+    /**\r
+     * Name of the entity reporting the event, for example, an EMS name; may be the same as sourceName\r
+     *\r
+     * @param reportingEntityName New value for reporting Entity Name\r
+     * @return Name of the entity reporting the event, may be the same as sourceName\r
+     */\r
+    private String reportingEntityName;\r
+\r
+\r
+    /**\r
+     * Ordering of events communicated by an event source instance or 0 if not needed\r
+     *\r
+     * @param sequence New value for Sequence\r
+     * @return Ordering of events communicated by an event source instance or 0 if not needed\r
+     */\r
+    private Integer sequence;\r
+\r
+\r
+    /**\r
+     * UUID identifying the entity experiencing the event issue; must be populated by the enrichment process\r
+     *\r
+     * @param sourceId New value for source id. Must be populated by the enrichment process\r
+     * @return UUID identifying the entity experiencing the event issue\r
+     */\r
+    private String sourceId;\r
+\r
+\r
+    /**\r
+     * Name of the entity experiencing the event issue\r
+     *\r
+     * @param sourceName New value for source name\r
+     * @return Name of the entity experiencing the event issue\r
+     */\r
+    private String sourceName;\r
+\r
+\r
+    /**\r
+     * the earliest unix time aka epoch time associated with the event from any component--as microseconds elapsed\r
+     * since 1 Jan 1970 not including leap seconds\r
+     *\r
+     * @param startEpochMicrosec New value for start Epoc Microsec\r
+     * @return The earliest unix time associated with the event from any component\r
+     */\r
+    private Long startEpochMicrosec;\r
+\r
+\r
+    /**\r
+     * Version of the event header\r
+     *\r
+     * @param version New value for version of the event header\r
+     * @return Version of the event header\r
+     */\r
+    private Float version;\r
+}\r