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