dcae-analytics-model/src/main/java/org/onap/dcae/apod/analytics/model/domain/cef/ThresholdCrossingAlertFields.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.onap.dcae.apod.analytics.model.domain.cef;
  22
  23 import java.util.List;
  24 import lombok.Data;
  25 import lombok.EqualsAndHashCode;
  26
  27 /**
  28  * Common Event Format - Fields Specific to threshold crossing alert events
  29  *
  30  * @author Rajiv Singla. Creation Date: 08/15/2017.
  31  */
  32 @Data
  33 @EqualsAndHashCode(callSuper = true)
  34 public class ThresholdCrossingAlertFields extends BaseCEFModel {
  35
  36     private static final long serialVersionUID = 1L;
  37
  38     /**
  39      * Additional Performance counters parameters.
  40      *
  41      * @param additionalParameters New value for Additional Performance counters
  42      * @return Additional Performance counters
  43      */
  44     private List<PerformanceCounter> additionalParameters;
  45
  46     /**
  47      *  Event alert action
  48      *
  49      *  @param alertAction New Event Action
  50      *  @return Event alert action
  51      */
  52     private AlertAction alertAction;
  53
  54     /**
  55      * Unique short alert description such as IF-SHUB-ERRDROP
  56      *
  57      * @param alertDescription New value for Unique short alert description
  58      * @return Unique short alert description
  59      */
  60     private String alertDescription;
  61
  62     /**
  63      * Alert type
  64      *
  65      * @param alertType New value for Alert Type
  66      * @return Alert Type
  67      */
  68     private AlertType alertType;
  69
  70     /**
  71      * Calculated API value (if applicable)
  72      *
  73      * @param alertValue New Calculated API value
  74      * @return Calculated API value (if applicable)
  75      */
  76     private String alertValue;
  77
  78     /**
  79      * List of eventIds associated with the event being reported
  80      *
  81      * @param associatedAlertIdList New value for eventIds associated with the event
  82      * @return List of eventIds associated with the event being reported
  83      */
  84     private List<String> associatedAlertIdList;
  85
  86     /**
  87      * Time when the performance collector picked up the data; with RFC 2822 compliant format:
  88      * ‘Sat, 13 Mar 2010 11:29:05 -0800’
  89      *
  90      * @param collectionTimestamp Set new value for time when the performance collector picked up the data
  91      * @return Time when the performance collector picked up the data
  92      */
  93     private String collectionTimestamp;
  94
  95     /**
  96      * Specific performance collector instance used
  97      *
  98      * @param dataCollector New value for specific performance collector instance used
  99      * @return Specific performance collector instance used
 100      */
 101     private String dataCollector;
 102
 103     /**
 104      * Type of network element
 105      *
 106      * @param elementType New value for type of network element
 107      * @return Type of network element
 108      */
 109     private String elementType;
 110
 111     /**
 112      * Event severity or priority
 113      *
 114      * @param eventSeverity New value for event severity or priority
 115      * @return Event severity or priority
 116      */
 117     private EventSeverity eventSeverity;
 118
 119     /**
 120      * Time closest to when the measurement was made; with RFC 2822 compliant format: ‘Sat, 13 Mar 2010 11:29:05 -0800’
 121      *
 122      * @param eventStartTimestamp New value for time closest to when the measurement was made
 123      * @return Time closest to when the measurement was made
 124      */
 125     private String eventStartTimestamp;
 126
 127     /**
 128      * Physical or logical port or card (if applicable)
 129      *
 130      * @param interfaceName New value for Physical or logical port or card (if applicable)
 131      * @return Physical or logical port or card (if applicable)
 132      */
 133     private String interfaceName;
 134
 135     /**
 136      * Network name
 137      *
 138      * @param networkService New value for network name
 139      * @return Network name
 140      */
 141     private String networkService;
 142
 143     /**
 144      * Possible Root Cause (reserved for future use)
 145      *
 146      * @param possibleRootCause New value for possible root cause (reserved for future)
 147      * @return Possible Root Cause (reserved for future use)
 148      */
 149     private String possibleRootCause;
 150
 151     /**
 152      * Version of the thresholdCrossingAlertFields block
 153      *
 154      * @param thresholdCrossingFieldsVersion New value for version of the thresholdCrossingAlertFields block
 155      * @return Version of the thresholdCrossingAlertFields block
 156      */
 157     private Integer thresholdCrossingFieldsVersion;
 158 }