Sonar Critical Fix
[dcaegen2/analytics/tca.git] / dcae-analytics-model / src / main / java / org / openecomp / dcae / apod / analytics / model / domain / cef / ThresholdCrossingAlertFields.java
1 /*\r
2  * ============LICENSE_START=========================================================\r
3  * dcae-analytics\r
4  * ================================================================================\r
5  *  Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
6  * ================================================================================\r
7  *  Licensed under the Apache License, Version 2.0 (the "License");\r
8  *  you may not use this file except in compliance with the License.\r
9  *  You may obtain a copy of the License at\r
10  *\r
11  *        http://www.apache.org/licenses/LICENSE-2.0\r
12  *\r
13  *  Unless required by applicable law or agreed to in writing, software\r
14  *  distributed under the License is distributed on an "AS IS" BASIS,\r
15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
16  *  See the License for the specific language governing permissions and\r
17  *  limitations under the License.\r
18  * ============LICENSE_END=========================================================\r
19  */\r
20 \r
21 package org.openecomp.dcae.apod.analytics.model.domain.cef;\r
22 \r
23 import java.util.List;\r
24 import lombok.Data;\r
25 import lombok.EqualsAndHashCode;\r
26 \r
27 /**\r
28  * Common Event Format - Fields Specific to threshold crossing alert events\r
29  *\r
30  * @author Rajiv Singla. Creation Date: 08/15/2017.\r
31  */\r
32 @Data\r
33 @EqualsAndHashCode(callSuper = true)\r
34 public class ThresholdCrossingAlertFields extends BaseCEFModel {\r
35 \r
36     private static final long serialVersionUID = 1L;\r
37 \r
38     /**\r
39      * Additional Performance counters parameters.\r
40      *\r
41      * @param additionalParameters New value for Additional Performance counters\r
42      * @return Additional Performance counters\r
43      */\r
44     private List<PerformanceCounter> additionalParameters;\r
45 \r
46     /**\r
47      *  Event alert action\r
48      *\r
49      *  @param alertAction New Event Action\r
50      *  @return Event alert action\r
51      */\r
52     private AlertAction alertAction;\r
53 \r
54     /**\r
55      * Unique short alert description such as IF-SHUB-ERRDROP\r
56      *\r
57      * @param alertDescription New value for Unique short alert description\r
58      * @return Unique short alert description\r
59      */\r
60     private String alertDescription;\r
61 \r
62     /**\r
63      * Alert type\r
64      *\r
65      * @param alertType New value for Alert Type\r
66      * @return Alert Type\r
67      */\r
68     private AlertType alertType;\r
69 \r
70     /**\r
71      * Calculated API value (if applicable)\r
72      *\r
73      * @param alertValue New Calculated API value\r
74      * @return Calculated API value (if applicable)\r
75      */\r
76     private String alertValue;\r
77 \r
78     /**\r
79      * List of eventIds associated with the event being reported\r
80      *\r
81      * @param associatedAlertIdList New value for eventIds associated with the event\r
82      * @return List of eventIds associated with the event being reported\r
83      */\r
84     private List<String> associatedAlertIdList;\r
85 \r
86     /**\r
87      * Time when the performance collector picked up the data; with RFC 2822 compliant format:\r
88      * ‘Sat, 13 Mar 2010 11:29:05 -0800’\r
89      *\r
90      * @param collectionTimestamp Set new value for time when the performance collector picked up the data\r
91      * @return Time when the performance collector picked up the data\r
92      */\r
93     private String collectionTimestamp;\r
94 \r
95     /**\r
96      * Specific performance collector instance used\r
97      *\r
98      * @param dataCollector New value for specific performance collector instance used\r
99      * @return Specific performance collector instance used\r
100      */\r
101     private String dataCollector;\r
102 \r
103     /**\r
104      * Type of network element\r
105      *\r
106      * @param elementType New value for type of network element\r
107      * @return Type of network element\r
108      */\r
109     private String elementType;\r
110 \r
111     /**\r
112      * Event severity or priority\r
113      *\r
114      * @param eventSeverity New value for event severity or priority\r
115      * @return Event severity or priority\r
116      */\r
117     private EventSeverity eventSeverity;\r
118 \r
119     /**\r
120      * Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’\r
121      *\r
122      * @param eventStartTimestamp New value for time closest to when the measurement was made\r
123      * @return Time closest to when the measurement was made\r
124      */\r
125     private String eventStartTimestamp;\r
126 \r
127     /**\r
128      * Physical or logical port or card (if applicable)\r
129      *\r
130      * @param interfaceName New value for Physical or logical port or card (if applicable)\r
131      * @return Physical or logical port or card (if applicable)\r
132      */\r
133     private String interfaceName;\r
134 \r
135     /**\r
136      * Network name\r
137      *\r
138      * @param networkService New value for network name\r
139      * @return Network name\r
140      */\r
141     private String networkService;\r
142 \r
143     /**\r
144      * Possible Root Cause (reserved for future use)\r
145      *\r
146      * @param possibleRootCause New value for possible root cause (reserved for future)\r
147      * @return Possible Root Cause (reserved for future use)\r
148      */\r
149     private String possibleRootCause;\r
150 \r
151     /**\r
152      * Version of the thresholdCrossingAlertFields block\r
153      *\r
154      * @param thresholdCrossingFieldsVersion New value for version of the thresholdCrossingAlertFields block\r
155      * @return Version of the thresholdCrossingAlertFields block\r
156      */\r
157     private Integer thresholdCrossingFieldsVersion;\r
158 }\r