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 / VNicPerformance.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 lombok.Data;\r
24 import lombok.EqualsAndHashCode;\r
25 \r
26 /**\r
27  * Describes the performance and errors of an identified virtual network interface card\r
28  * <p>\r
29  * @author Rajiv Singla. Creation Date: 08/15/2017.\r
30  */\r
31 @Data\r
32 @EqualsAndHashCode(callSuper = true)\r
33 public class VNicPerformance extends BaseCEFModel {\r
34 \r
35 \r
36     private static final long serialVersionUID = 1L;\r
37 \r
38     /**\r
39      * Cumulative count of broadcast packets received as read at the end of the measurement interval\r
40      *\r
41      * @param receivedBroadcastPacketsAccumulated New value for cumulative count of broadcast packets received as\r
42      * read at the end of the measurement interval\r
43      * @return Cumulative count of broadcast packets received as read at the end of the measurement interval\r
44      */\r
45     private Long receivedBroadcastPacketsAccumulated;\r
46 \r
47     /**\r
48      * Count of broadcast packets received within the measurement interval\r
49      *\r
50      * @param receivedBroadcastPacketsDelta New value for count of broadcast packets received within the measurement\r
51      * interval\r
52      * @return Count of broadcast packets received within the measurement interval\r
53      */\r
54     private Long receivedBroadcastPacketsDelta;\r
55 \r
56     /**\r
57      * Cumulative count of discarded packets received as read at the end of the measurement interval\r
58      *\r
59      * @param receivedDiscardedPacketsAccumulated New value for cumulative count of discarded packets received as read\r
60      * at the end of the measurement interval\r
61      * @return  Cumulative count of discarded packets received as read at the end of the measurement interval\r
62      */\r
63     private Long receivedDiscardedPacketsAccumulated;\r
64 \r
65     /**\r
66      * Count of discarded packets received within the measurement interval\r
67      *\r
68      * @param receivedDiscardedPacketsDelta New value for count of discarded packets received within the measurement\r
69      * interval\r
70      * @return Count of discarded packets received within the measurement interval\r
71      */\r
72     private Long receivedDiscardedPacketsDelta;\r
73 \r
74     /**\r
75      * Cumulative count of error packets received as read at the end of the measurement interval\r
76      *\r
77      * @param receivedErrorPacketsAccumulated New value for cumulative count of error packets received as read at the\r
78      * end of the measurement interval\r
79      * @return Cumulative count of error packets received as read at the end of the measurement interval\r
80      */\r
81     private Long receivedErrorPacketsAccumulated;\r
82 \r
83     /**\r
84      * Count of error packets received within the measurement interval\r
85      *\r
86      * @param receivedErrorPacketsDelta New value for count of error packets received within the measurement interval\r
87      * @return Count of error packets received within the measurement interval\r
88      */\r
89     private Long receivedErrorPacketsDelta;\r
90 \r
91     /**\r
92      * Cumulative count of multicast packets received as read at the end of the measurement interval\r
93      *\r
94      * @param receivedMulticastPacketsAccumulated New value for cumulative count of multicast packets received as\r
95      * read at the end of the measurement interval\r
96      * @return Cumulative count of multicast packets received as read at the end of the measurement interval\r
97      */\r
98     private Long receivedMulticastPacketsAccumulated;\r
99 \r
100     /**\r
101      * Count of multicast packets received within the measurement interval\r
102      *\r
103      * @param receivedMulticastPacketsDelta New value for count of multicast packets received within the measurement\r
104      * interval\r
105      * @return Count of multicast packets received within the measurement interval\r
106      */\r
107     private Long receivedMulticastPacketsDelta;\r
108 \r
109     /**\r
110      * Cumulative count of octets received as read at the end of the measurement interval\r
111      *\r
112      * @param receivedOctetsAccumulated New value for cumulative count of octets received as read at the end of the\r
113      * measurement interval\r
114      * @return Cumulative count of octets received as read at the end of the measurement interval\r
115      */\r
116     private Long receivedOctetsAccumulated;\r
117 \r
118     /**\r
119      * Count of octets received within the measurement interval\r
120      *\r
121      * @param receivedOctetsDelta New value for count of octets received within the measurement interval\r
122      * @return Count of octets received within the measurement interval\r
123      */\r
124     private Long receivedOctetsDelta;\r
125 \r
126     /**\r
127      * Cumulative count of all packets received as read at the end of the measurement interval\r
128      *\r
129      * @param receivedTotalPacketsAccumulated New value for cumulative count of all packets received as read at the\r
130      * end of the measurement interval\r
131      * @return Cumulative count of all packets received as read at the end of the measurement interval\r
132      */\r
133     private Long receivedTotalPacketsAccumulated;\r
134 \r
135     /**\r
136      * Count of all packets received within the measurement interval\r
137      *\r
138      * @param receivedTotalPacketsDelta New value for count of all packets received within the measurement interval\r
139      * @return Count of all packets received within the measurement interval\r
140      */\r
141     private Long receivedTotalPacketsDelta;\r
142 \r
143     /**\r
144      * Cumulative count of unicast packets received as read at the end of the measurement interval\r
145      *\r
146      * @param receivedUnicastPacketsAccumulated New value for cumulative count of unicast packets received as read at\r
147      * the end of the measurement interval\r
148      * @return Cumulative count of unicast packets received as read at the end of the measurement interval\r
149      */\r
150     private Long receivedUnicastPacketsAccumulated;\r
151 \r
152     /**\r
153      * Count of unicast packets received within the measurement interval\r
154      *\r
155      * @param receivedUnicastPacketsDelta New value for count of unicast packets received within the measurement\r
156      * interval\r
157      * @return Count of unicast packets received within the measurement interval\r
158      */\r
159     private Long receivedUnicastPacketsDelta;\r
160 \r
161     /**\r
162      * Cumulative count of broadcast packets transmitted as read at the end of the measurement interval\r
163      *\r
164      * @param transmittedBroadcastPacketsAccumulated New value for cumulative count of broadcast packets transmitted\r
165      * as read at the end of the measurement interval\r
166      * @return Cumulative count of broadcast packets transmitted as read at the end of the measurement interval\r
167      */\r
168     private Long transmittedBroadcastPacketsAccumulated;\r
169 \r
170     /**\r
171      * Count of broadcast packets transmitted within the measurement interval\r
172      *\r
173      * @param transmittedBroadcastPacketsDelta New value for count of broadcast packets transmitted within the\r
174      * measurement interval\r
175      * @return Count of broadcast packets transmitted within the measurement interval\r
176      */\r
177     private Long transmittedBroadcastPacketsDelta;\r
178 \r
179     /**\r
180      * Cumulative count of discarded packets transmitted as read at the end of the measurement interval\r
181      *\r
182      * @param transmittedDiscardedPacketsAccumulated New value for cumulative count of discarded packets transmitted\r
183      * as read at the end of the measurement interval\r
184      * @return Cumulative count of discarded packets transmitted as read at the end of the measurement interval\r
185      */\r
186     private Long transmittedDiscardedPacketsAccumulated;\r
187 \r
188     /**\r
189      * Count of discarded packets transmitted within the measurement interval\r
190      *\r
191      * @param transmittedDiscardedPacketsDelta New value for count of discarded packets transmitted within the\r
192      * measurement interval\r
193      * @return Count of discarded packets transmitted within the measurement interval\r
194      */\r
195     private Long transmittedDiscardedPacketsDelta;\r
196 \r
197     /**\r
198      * Cumulative count of error packets transmitted as read at the end of the measurement interval\r
199      *\r
200      * @param transmittedErrorPacketsAccumulated New value for cumulative count of error packets transmitted as read\r
201      * at the end of the measurement interval\r
202      * @return Cumulative count of error packets transmitted as read at the end of the measurement interval\r
203      */\r
204     private Long transmittedErrorPacketsAccumulated;\r
205 \r
206     /**\r
207      * Count of error packets transmitted within the measurement interval\r
208      *\r
209      * @param transmittedErrorPacketsDelta New value for count of error packets transmitted within the measurement\r
210      * interval\r
211      * @return Count of error packets transmitted within the measurement interval\r
212      */\r
213     private Long transmittedErrorPacketsDelta;\r
214 \r
215     /**\r
216      * Cumulative count of multicast packets transmitted as read at the end of the measurement interval\r
217      *\r
218      * @param transmittedMulticastPacketsAccumulated New value for cumulative count of multicast packets transmitted\r
219      * as read at the end of the measurement interval\r
220      * @return Cumulative count of multicast packets transmitted as read at the end of the measurement interval\r
221      */\r
222     private Long transmittedMulticastPacketsAccumulated;\r
223 \r
224     /**\r
225      * Count of multicast packets transmitted within the measurement interval\r
226      *\r
227      * @param transmittedMulticastPacketsDelta New value for count of multicast packets transmitted within the\r
228      * measurement interval\r
229      * @return Count of multicast packets transmitted within the measurement interval\r
230      */\r
231     private Long transmittedMulticastPacketsDelta;\r
232 \r
233     /**\r
234      * Cumulative count of octets transmitted as read at the end of the measurement interval\r
235      *\r
236      * @param transmittedOctetsAccumulated New value for cumulative count of octets transmitted as read at the end of\r
237      * the measurement interval\r
238      * @return Cumulative count of octets transmitted as read at the end of the measurement interval\r
239      */\r
240     private Long transmittedOctetsAccumulated;\r
241 \r
242     /**\r
243      * Count of octets transmitted within the measurement interval\r
244      *\r
245      * @param transmittedOctetsDelta New value for count of octets transmitted within the measurement interval\r
246      * @return Count of octets transmitted within the measurement interval\r
247      */\r
248     private Long transmittedOctetsDelta;\r
249 \r
250     /**\r
251      * Cumulative count of all packets transmitted as read at the end of the measurement interval\r
252      *\r
253      * @param transmittedTotalPacketsAccumulated New value for cumulative count of all packets transmitted as read at\r
254      * the end of the measurement interval\r
255      * @return Cumulative count of all packets transmitted as read at the end of the measurement interval\r
256      */\r
257     private Long transmittedTotalPacketsAccumulated;\r
258 \r
259     /**\r
260      * Count of all packets transmitted within the measurement interval\r
261      *\r
262      * @param transmittedTotalPacketsDelta New value for count of all packets transmitted within the measurement\r
263      * interval\r
264      * @return Count of all packets transmitted within the measurement interval\r
265      */\r
266     private Long transmittedTotalPacketsDelta;\r
267 \r
268     /**\r
269      * Cumulative count of unicast packets transmitted as read at the end of the measurement interval\r
270      *\r
271      * @param transmittedUnicastPacketsAccumulated New value for cumulative count of unicast packets transmitted as\r
272      * read at the end of the measurement interval\r
273      * @return Cumulative count of unicast packets transmitted as read at the end of the measurement interval\r
274      */\r
275     private Long transmittedUnicastPacketsAccumulated;\r
276 \r
277 \r
278     /**\r
279      * Count of unicast packets transmitted within the measurement interval\r
280      *\r
281      * @param transmittedUnicastPacketsDelta New value for count of unicast packets transmitted within the\r
282      * measurement interval\r
283      * @return Count of unicast packets transmitted within the measurement interval\r
284      */\r
285     private Long transmittedUnicastPacketsDelta;\r
286 \r
287 \r
288     /**\r
289      * Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other conditions\r
290      *\r
291      * @param valuesAreSuspect New value to indicate whether vNicPerformance values are likely inaccurate due to\r
292      * counter overflow or other conditions\r
293      * @return Indicates whether vNicPerformance values are likely inaccurate due to counter overflow or other\r
294      * conditions\r
295      */\r
296     private Boolean valuesAreSuspect;\r
297 \r
298 \r
299     /**\r
300      * Virtual Network Card Identifier\r
301      *\r
302      * @param vNicIdentifier New value for Virtual Network Card Identifier\r
303      * @return Virtual Network Card Identifier\r
304      */\r
305     private String vNicIdentifier;\r
306 \r
307 \r
308 }\r