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